Authentication

The CEIPAL API uses a combination of Username, Password, and an API Key to authenticate and generate a Bearer Token. This Bearer Token is required to access all API endpoints.

Your API keys carry significant privileges, so they must be kept secure. Do not share your secret API keys.

CEIPAL also provides an option to rotate API credentials by updating the API password. Regular rotation is recommended to maintain security and prevent unauthorized access.

access_token valid for 1 hour

refresh_token valid for 7 days

All API requests must be made over HTTPS. Requests sent over plain HTTP are not supported and will fail.

Header Parameters

Content-Typestring

Body Parameters

emailstring Required

Email address that has administrator access to the ATS product

passwordstring Required

Password that is configured in the ATS Admin Panel to use the API

apiKeystring Required

API Key that is configured in the ATS Admin Panel to use this API.

Response

200

Object

Response Attributes

access_tokenstring

refresh_tokenstring

400

Object

Sections

Authentication

Header Parameters

Body Parameters

Response

Response Attributes

What made this section helpful for you?

What made this section unhelpful for you?

Response

What made this section helpful for you?

What made this section unhelpful for you?