Gazelle Point-of-Sale provides a set of APIs that allows you to read and manipulate your Point-of-Sale data programatically. Our APIs allow you to build custom solution or software that interacts and integrates seamlessly with our Point-of-Sale. Our APIs have the following specifications:


Before you start using our APIs, you will need to do the following steps:


STEP 1 - Obtain your Gazelle Cloud ID

  1. Visit this page http://gazelle.phostersoft.com/gazelleoffline.php
  2. Enter the e-mail address that you used to register your Gazelle Cloud account
  3. Click Enter

STEP 2 - Authenticate


To authenticate yourself for API access, you will need to do a HTTP GET/POST request to the APIs end-point with the following parameters:

PARAMETER VALUE
a <Gazelle Cloud ID>
action authenticate
username <Staff User Name>
password <Staff Password>

For example, the parameters to access our Demo Gazelle Cloud account are as following:

PARAMETER VALUE
a b0bfa14759
action authenticate
username demo
password password1


Hence, we authenticate into the Demo Gazelle Cloud account with this request:

https://cloud.phostersoft.com/api?a=b0bfa14759&action=authenticate&username=demo&password=password1

STEP 3 - Test an API


Now, let's try to use the API to read the last THREE sale transactions from your Gazelle Point-of-Sale.


Here are the parameters to be used:

PARAMETER VALUE
a

<Gazelle Cloud ID>

action read
query sale
start 1
end 3


For example, the parameters to read the last THREE sale transactions from our Demo Gazelle Cloud account are as following:

PARAMETER VALUE
a

b0bfa14759

action read
query sale
start 1
end 3


Hence, we read the last THREE sale transactions from our Demo Gazelle Cloud account with this request:

https://cloud.phostersoft.com/api?a=b0bfa14759&action=read&query=sale&start=1&end=3


STEP 4 - You're Good to Go!


The other APIs' documentation is available from this page http://support.phostersoft.com/solution/categories/23788/folders/267351. We will provide the documentation as a PARAMETER-VALUE table, which you can use in similar ways as how you did the Step 2 and Step 3 above. For more complex cases, we will provide examples as of how the APIs are being used on our Demo Gazelle Cloud account. Note that before using any of our APIs, Authentication (as shown is Step 2 above) must be performed first.