This topic describes the request methods, endpoints, and request header parameters that are used in your API requests to Atlato Core.

Request methods

The API requests to Atlato Core support the following request methods.

Method	Description
GET	Requests the server to return the specified resources.
PUT	Requests the server to update the specified resources.
POST	Requests the server to perform the specified operations.
DELETE	Requests the server to delete the specified resources.

NOTE

When the request method POST is used, the Content-Type parameter must be set to application/json.

Endpoints

Atlato Core API endpoints can vary depending on different countries or regions. You can select an endpoint for the country or region where your devices are deployed. This makes your services more responsive to API requests. More regions will be introduced later.

Region	Endpoint
Australian Data Center	https://openapi.au.atlato.com
Singapore Data Center	https://openapi.sg.atlato.com

Request header parameters

The following table lists the common request header parameters used in the API requests to Atlato Core. You must set the values of the required parameters in the request headers.

Common Header

clientId

enum<integer>

required

Client of Application. This is always Atlato

Fixed value:

appId

integer

required

Generated Application Id given by the developer platform

platform

enum<integer>

required

Incoming request's platform

Allowed values:

1235

Example:

Authorization

string

required

Apply access token for authentication

Example:

Bearer edsdsfklaskdsl....

Request Structure

Request methods#

Endpoints#

Request header parameters#

Request methods

Endpoints

Request header parameters