Chynge API

Chynge public API is at https://developer.chynge.com

When you use the interactive API documentation, most of the endpoints will give 'not authorized' message unless you are authorized.

To become authorized, copy access_token as the api_key input in the 'Authorize' before you do the 'try it out'. See how to get access_token by reading the rest of the documentation below.

Developer's API key and secret

Chynge sends out API key (client_id) and Secret key (client_secret) to developers manually. Please send email to info@chynge.com to request access.

The initial API key is to be used with a sandbox. The sandbox comes with a preloaded sample database.

When developer is ready to deploy to production, please send email to info@chynge.com and we will give you a production API and Secret key.

Authentication

Chynge API follows OAuth 2.0 specification for authentication. The API supports client credential grant to be used for developers created middleware applications and authorization code grant for mobile and SPA type applications.

In the past the API supported the use of resource owner credential grant. It is now discouraged and will not be supported in the future. Applications that have been using resource owner credential grant will continue to work.

Authenticate through client credential grant

This section is intended as how to for developer's trusted middleware application (middleware-app) to authenticate to Chynge API through client credential grant.

To aquire an access_token middleware-appe sends a POST request to api.chynge.com/v1/auth with the following body parameters:

• client_id
• client_secret

curl -X POST --header 'Content-Type: application/json' -d '{ \ 
   "client_secret": "tUSfmzgzV0LMsuwgxxxxxxxxxxxxxxxxxxxxxxxxx", \ 
   "client_id": "U3kTfxxxxxxxxxxxxxxx" \ 
 }' 'https://api.chynge.com/v1/auth'

The authorization server will respond with a JSON object containing following properties:

• token_type with the value of 'Bearer'
• expires_in with an integer representing the TTL of the access token
• access_token is the access token itself

 {
  "access_token": "eyJ0eXAxxxxxxxxxx.asdfasdfxxxxxxxxxx.uiokdfhksjdxxxxxx",
  "expires_in": 86400,
  "token_type": "Bearer"
}

Middleware-app can now use the returned access_token as the bearer token to authenticate with Chynge API endpoints.

curl -X GET --header 'Authorization: eyJ0eXAiOiJKV1QiLCxxxxxxxxxxxxxxxxx' 'https://api.chynge.com/v1/country'

[
  {
    "country": "Indonesia",
    "countryCode": "ID"
  },
  {
    "country": "Malaysia",
    "countryCode": "MY"
  },
  {
    "country": "Singapore",
    "countryCode": "SG"
  }
]

When you're using our interactive API documentation, access_token is the value that you want to copy to the api_key input in the 'Authorize' before you do the 'try it out'.