REST API Module for UltimatePOS

Before you Purchase: 

1. Note that this is not a standalone application, it is an “Optional” extension to UltimatePOS Advance
2. This module is compatible with SaaS/Superadmin module.

API or Connector Module for UltimatePOS

This module provides the API for use in UltimatePOS

API Documentation:

We’ve detailed API documentation which includes all API endpoints, input request output response, and more.

It is included with the API module which you’ll be getting upon purchasing.

 After purchasing & API module installation, just go to yourwebsite.com/docs, and there you’ll find the documentation

API Documentation showing 404 error:

1. Solution 1: Follow the steps mentioned below in “Additional update steps” 

1. 
   OR
2. Solution 2: If you’ve SSH access or terminal(cmd line) access to the server or using localhost, go inside pos directory and run the below command:
   php artisan scribe:generate
   OR
3. Solution 3: Download this zip file, upload it inside pos/public directory, and unzip it there.

Try any of the above methods, method 3 is the easiest.

After doing open your website document, hopefully it should work now.

 Additional update steps:

This step needs to be followed after updating UltimatePOS:

1. Login with superadmin account
2. Go Modules screen in the sidebar
3. Click on the “Regenerate” button as given in the screenshot below.

Generating client id & Client secret:

1. After installing the API-Connector module login with superadmin username & password
2. Go to Connector -> Clients
3. Click on “Create Client” button and it will show a popup.
4. Enter the name (any name is fine) & Save
5. In the list of clients, it will show the id, & secret. Check screenshow below.

NOTE: Only the superadmin users can view the Connector -> Clients page. So if any other users need a client id or secret then the superadmin user should generate and send it to them.