Codelayer API Documentation

This Document describes the details of Codelayer API, its functionalities and usage.

All calls To the API Is done Using JSON HTTPs POST, unless otherwise specified In the corresponding section. There are two parts For the URL first part Is the API location eg: https : //ti.api.codelayer.co.in/ This part should be configurable by the end user and this only changes when the hosting of the API is changed. The second part is the actual location in the API and is described in this documentation. This part is fixed and will only change when there Is a major change in the API functionality.

Example : If the fixed part is https://ti.api.codelayer.co.in/ and URL of Authentication, as per document is system/auth so the full URL for Authentication will be https://ti.api.codelayer.co.in/system/auth

The Key field should be always present in all the API calls except for Authentication, which generates the key. The key may expire on inactivity, and should be re-obtained in such cases with re-authentication.

Fields e and msg will be always present In all responses, and any response from the API without these two fields should be treated as error.

There can be multiple failure responses, but may not be listed in current version of document.

Min

• String: Minimum length of the string.
• Integer: Minimum value.

Max

• String: Maximum length of the string.
• Integer: Maximum value.

Mandatory Response Fields

• e : Status Code. Status code 200 Is success.
• msg : Response status description.

Details of status code and description can be found In the Response Codes section.