General API help and troubleshooting

Permissions

To work with the API, the user must have the required permissions on the Tenant :

• API permissions
• desired object permissions : for example, for API queries on Schedules, the user must have permissions on Schedules
  

API location

The API responds on the Back-End website (Alpana3App).

Resources

API Code snippets on Alpana Server

On your Alpana Server tenants, users with permissions to the API have access to auto-generated code snippets to help you make common requests.
So use this utility, login to the desired tenant (to the Front-End) and navigate to menu API :

Swagger UI : Automatic documentation and test

Swagger UI allows you to access the full list of API endpoints, along with some auto-generated documentation, and an interface for testing queries.
To access it, simply use your web browser to navigate on the Back-End website of Alpana Server.

Login with your tenant credentials, and use the Swagger web page to browse endpoints, unfold their documentation, and try them from the browser.

Testing with Postman

You can easily test your API queries with a third-party tool called Postman .

This allows you to configure all parameters of the queries, and generate code in your programming language.

Common issues

If your application is a web application running in a browser, it will need to be allowed to make queries to the API. Otherwise, you will encounter CORS errors.
In order to do this, see API Origins Whitelist.