# Specification

# API types

Open API are HTTPS APIs. There are 2 types of API: Request API and Callback API.

# Request API

The API call is requested from Client system to Zeek platform.

# Callback API

The Zeek platform updates developer by means of callback API. For example, when the delivery order status is changed, the platform will send the latest status to client system via callback API. Therefore developer needs to provide the callback URL to platform.

# Standard

• HTTPS protocol should be applied in API requests.
• UTF-8 encoding is used.
• Payload of API request and response are in JSON format.

# API URL

# Sandbox environment

Developers can perform API integration and testing on Sandbox environment.

• We provide different development environment for client who requires customized integration. Please contact our team for details.

# Release environment

Release environment is for live service.

# API Request

An example of API request by Curl:

curl --location --request POST 'https://ap1-open-api.zeek.one/parcel/v1.0/vas' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
--header 'KS-Region: SG' \
--header 'KS-Lang: en' \
--header 'KS-Client-Request-Id: f058ebd6-02f7-4d3f-942e-904344e8cde5' \
--data-raw '{
    "merchant_id": "1111111",
    "product_code": "DASH2HR"
}'

# HTTP Header

Please send the following HTTP headers in API requests.

# Content-Type

Please send application/json;charset=UTF-8, as all API request are in UTF-8 encoding and JSON.

# Authorization

You need to send access token in Authorization header, in order to get authorized to Zeek Open API access. Please refer to Authentication。

# KS-Region

Input the region in service:

# KS-Lang

Please send the language according to region:

# KS-Client-Request-Id

You are suggested to send a UUID in KS-Client-Request-Id Header. It helps us to locate the API request during troubleshooting. An example of UUID is f058ebd6-02f7-4d3f-942e-904344e8cde5.

# API Response

# HTTP status code

The HTTP status code will be included in API response:

• 200 OK
• 400 Bad Request
• 401 Unauthorized
• 403 Forbidden
• 404 Not Found
• 500 Internal Server Error

# HTTP Header

The following HTTP headers will be included in API response:

# Payload format

Example of a successful API request:

{
    "error" : 0,
    "data": {
        "token_type": "Bearer",
        "access_token": "xxxxxxxxxxxxxxxxxxxxxxx",
        "expires_in": 86400,
        "scope": "delivery"
    }
}

Example of a failed API request:

{
    "error": 261004,
    "err_msg": "Incorrect parameters"
}

# Timezone

The timezone for API requests and responses are local time. The local timezone is defined according to region value. For example, if region="HK", the timezone should be UTC+8.

# Geolocation

The coordinates data format in use is "latitude,longitude". For example, 22.285944,114.158177.

# Authentication

We use Client credentials flow of Oauth for API authentication. Here are the steps:

• Step 1: Developer obtains AppId and AppSecret from Zeek team.
• Step 2: Client system request PA-API-1.1 Get access token, use AppId and AppSecret to exchange the Access token. The TTL of access token is 24 hours.
• Step 3: While requesting other API, include access token in HTTP Header in the format: Authorization: Bearer [Access token]. Then the API request will be authenticated.

# Error codes