WebAPI

Swagger

Realtime request are aviable over swagger

Access token

All API request required access token. Use token endpoint to get access token. Token endpoint accept password or refresh token.

Get access token with password grant

POST /token HTTP/1.1

grant_type=password
&username=user@example.com
&password=1234luggage
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache

{
"access_token":"ATQ0N3JkZmQ2OTM2NDE1ZTZjNGZmZjI5",
"token_type":"bearer",
"expires_in":3600,
"refresh_token":"IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk"
}

Get access token with refresh token

POST /token HTTP/1.1

grant_type=refresh_token
&refresh_token=IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk"
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache

{
"access_token":"ATQ0N3JkZmQ2OTM2NDE1ZTZjNGZmZjI5",
"token_type":"bearer",
"expires_in":3600
}

Making API Requests

GET /examples/codebook HTTP/1.1

Authorization: Bearer ATQ0N3JkZmQ2OTM2NDE1ZTZjNGZmZjI5

Making API Requests with parameter

GET /examples/codebook/sy_Weekday HTTP/1.1

Authorization: Bearer ATQ0N3JkZmQ2OTM2NDE1ZTZjNGZmZjI5

OData Query Options

WebAPI supports the following OData query options:

Option Description Using
$skip Skips the first n results. 'request url' + '?$skip=20'
$top Select top item from results. 'request url' + '?$top=5'

Making API Requests with OData Query

GET /examples/codebook?$skip=80&$top=5 HTTP/1.1

Authorization: Bearer ATQ0N3JkZmQ2OTM2NDE1ZTZjNGZmZjI5

Postman testing

Import file from Testing folder into Postman