Appy Pie API, Docs REST API Overview, API Integration Tutorial


Authentication is done via the API key which you can find in your account settings.

Appy Pie provides a number of APIs for different features to allow users to obtain information on various categories in the database. Our APIs are based on REST and use standard HTTP response codes, verbs, and authentication. Using Appy Pie APIs, you can develop a reliable integration between your system and our platform. This will enable you to obtain and manage the required data available on our platform.

With bindings in multiple programming languages including Shell, PHP, NodeJs, and JavaScript, you can easily switch to your preferred language to view the sample code. Appy Pie APIs include APIs for our Food Court Feature, Store Feature, and Form Builder Feature. You can access API endpoints for the respective features to retrieve information on various categories in our database. For instance, using the Food Court APIs, you can obtain all the information that exists in the Foodcourt feature. Similarly, you can use the Store and Formbuilder APIs to obtain information that exists in the respective features.

Do not share or publish the Access Token Key.

To generate a new access token key, Please use the Request URL and right side process.


Parameter NameRequiredParameter TypeParameter Description
tokenKeyYesStringToken Key is pre-defined.
secretKeyYesStringSecret Key is pre-defined.
To generate a new access token key, follow the right side process.


This error section displays all the errors with details.

Following are the error codes that indicate the success or failure of an API request:

Error CodeMeaning
400Bad Request -- Your request is invalid.
401Unauthorized -- Your API key is wrong.
403Forbidden -- The method requested is hidden for administrators only.
404Not Found -- The specified method could not be found.
405Method Not Allowed -- You tried to access a method with an invalid method.
406Not Acceptable -- You requested a format that is not json.
410Gone -- Request has been removed from our servers.
429Too Many Requests
500Internal Server Error -- We had a problem with our server. Try again later.
503Service Unavailable -- We are temporarily offline for maintenance. Please try again later.
2032API Key is required
2034Email is required
2036Invalid API Key
2038Provide valid API Key
2039Email already exists
2040Phone already exists
2041Email Invalid
To authorize, use this code:

1wget --no-check-certificate --quiet \
2	--method POST \
3	--timeout=0 \
4	--header "ACCESSTOKEN: Access Token Key" \
5	--header "Content-Type: application/json" \
6	--body-data
7	'{
8		"tokenKey":"TOKEN_KEY",
9		"secretKey":"SECRET_KEY"
10	 }' \
11	""


  "status": "1",
  "accessToken": ACCESS_TOKEN