Public API

The Public API Permissions feature provides a structured way to manage access of API users by restricting or allowing specific actions for different groups of users. With this feature, the admin users can define which groups of API users can work with specific endpoints, ensuring that sensitive operations are protected. You need your own API user and the right permissions before starting working on an API. Follow the guideline Public API permissions.

The Content Type is application/json.

If you are using HTTP format, configure your code as suggested below:

GET {endpoint} HTTP/1.1

Host: {shop URL}

Content-Type: application/json

Authorization: {PublicApiV2} {access token} (prefixed with PublicApi for API V1 or PublicApiV2 for API V2)

Example

GET /api/v2/databaseusages HTTP/1.1

Host: https://colengo.com/api/v2/databaseusages

Content-Type: application/json

Authorization: PublicApiV2 CfDJ8B8s8hJ17wNGjBre3rky4f_Go03_UaVkR68yE92KSci1HZZPHuPRMXgwRpAnItIixvgJMyIZCV8THyybmTVfza_9BMTINlXoDdLFBAojhpGAWnudazxAJvRfR_cCpiTFl8GSurCu0f3VNt4WHG5xCg326TSM-lw5sg

If you are using cURL format, configure your code as suggested below:

curl --location '{shop URL}{endpoint}' \

--header 'Content-Type: application/json' \

--header 'Authorization: {PublicApiV2} {access token}' (prefixed with PublicApi for API V1 or PublicApiV2 for API V2)

Example

curl --location 'https://colengo.com/api/v2/databaseusages' \

--header 'Content-Type: application/json' \

--header 'Authorization: PublicApiV2 CfDJ8B8s8hJ17wNGjBre3rky4f_Go03_UaVkR68yE92KSci1HZZPHuPRMXgwRpAnItIixvgJMyIZCV8THyybmTVfza_9BMTINlXoDdLFBAojhpGAWnudazxAJvRfR_cCpiTFl8GSurCu0f3VNt4WHG5xCg326TSM-lw5sg'

If you are using postman, configure the following variables:

- host – the shop URL - access_token – the access token for API Version 1 (prefixed with PublicApi)

- access_token_v2 – the access token for API Version 2 (prefixed with PublicApiV2)

Note: Only one API version can be active at a time.

To begin, you must first get a Refresh Token.

        1. Navigate to “Shop App Tokens” under API menu.

        2. Click “Add token”

        3. Specify Token name and select Public API User.

After saving, the system will generate and return a Refresh Token.

Next, request an Access Token by sending a POST request to the Renew Token endpoint (/api/v1/tokens/renewtokens or /api/v2/tokens/renewtokens) using the Refresh Token. Use the returned Access Token as the value for your environment variable. System will return you with a new Refresh token 5 days after the current one is active.

- 400 Bad Request

- 401 Unauthorized (Token expired or invalid\incorrect)

- 403 Forbidden (Not enough permissions)

The GET List endpoints in API Version 2 return data in a paginated format. This section explains how to navigate to the next or previous pages of results.

1. Firstly, send an API request.

2. Then, the response body and the metadata object will be returned. The metadata object will include data for navigating
     to the next page or returning to the previous page. Metadata object contains the following:

          - "hasNext" indicates if there is the next page.

          - "hasPrevious" indicates if there is the previous page.

          - "next" contains the extra paremeter 'after={value}' to navigate to the next page.

                  - To go to the next page, add the extra parameter 'after={value}' at the end of the endpoint URL.

          - "previous" contains the extra paremeter 'before={value}' to navigate to the previous page.

                  - To return to the previous page, add the extra parameter 'before={value}' at the end of the endpoint URL.

All date times are per ISO 8601. If the time zone isn’t specified in the date and time within a request body, system will save the date and time in UTC + 0.

All URLs are case insensitive.