Authentication

Authenticate using the Checkout Authentication API

The Checkout Authentication API offers various endpoints, each requiring different authentication methods based on the use case:

Basic Auth Utilize OAuth Client credentials for secure access.
Bearer Auth Employ Access Tokens for authenticated requests.
No Auth Some endpoints are publicly accessible without authentication.

Check the API Specification for detailed authentication requirements for each endpoint.

For endpoint access, use the following host: https://{{tenant-space}}.auth.scayle.cloud

HTTP Status Codes and Error Handling

The Checkout Authentication APII uses HTTP status codes to signify the outcome of API requests:

2xx: Successful operations.
4xx: Failures due to incorrect or insufficient information provided by the user.
5xx: Errors originating from Auth Api's servers.

In the event of an error, Authentication API issues an error response with error details. Typically, this includes a single error, but some endpoints may return multiple errors.

For a comprehensive understanding, refer to the following tables detailing status codes, error responses, and error entities.

HTTP Status Codes

HTTP Status Code	Name	Description
200	OK	Request successfully fulfilled.
201	Created	New resource successfully created.
204	No Content	Request fulfilled with no content to send in the response.
206	Partial Content	Partial content of the requested resource successfully delivered.
400	Bad Request	Request contains invalid parameters or is malformed.
401	Unauthorized	Authentication failed or missing, see access.
404	Not Found	Specified resource does not exist.
408	Request Timeout	Request timed out on the server.
409	Conflict	Conflict with the current state of the resource.
412	Precondition Failed	Failure in a requested dependency.
413	Payload Too Large	Request entity exceeds the server's size limits.
424	Failed Dependency	Request failed due to failure of dependency.
500	Internal Server Error	An unexpected error on the Authentication API server.
503	Service Unavailable	Authentication API is temporarily unavailable.

For endpoint-specific error codes, refer to the Checkout Authentication API.