Ground rules for API

The API provided by SkyJoy and Partners must follow the rules below.

API protocol

All APIs must be provided based on JSON over HTTP and support HTTPS.

• Content-Type is application/json and charset is utf-8.

• Partner System must support TLS 1.2 or higher protocol for secure data transmission.

Security

API requests should be authenticated via Bearer Authentication. Therefore the request should include HTTP Authorization Header with Access Token issued by API owner which would be SkyJoy or 3rd Party Partner.

// Authorization: Bearer {Access Token}

For security reasons, 3rd Party Partner should provide a domain name (ex. mydomain.com) to SkyJoy System. SkyJoy System manages the information.

API versioning

The version of the API exists as vX after the Base URL. The current API version is v1 .

The full URL configuration is: {BASE_SERVICE_URL}/partner/{version}/{path}.

Sample URL:

For UAT environment

https://api.uat.skyjoy.io/api-user/partner/v1/user-profile/SJ1234567890

For Production environment

https://api.skyjoy.vn/api-user/partner/v1/user-profile/SJ1234567890

The base URL provided by SkyJoy System is defined in this documentation. 3rd Party Partner should provide base URL information to SkyJoy.

API performance

Every API response time should be no longer than 2 seconds.

GJ API-Gateway timeout is 30 seconds and return 500-Server Internal Error.

In case the API response time exceeds 2 seconds for a certain period of time, SkyJoy System would pause requesting the API for a couple of minutes and then request again.

If the delay continues, SkyJoy shall notify the partner and ask to fix it.