Authentication

You need to be an Apizee authenticated user to use the APIs:

1. Get your account on the Apizee plaform depending on what endpoint you need.

2. Use the /token endpoint providing your username and password to get a token in return (see Bearer Authentication).

3. Include the token in the Authorization header of requests:

   Authorization: Bearer <token>

Be mindful that you get the authentication token by passing clear username and password along with your API call; this operation must be done server-sided to avoid security issues and NOT by your frontend part.

Returns access token

post

https://cloud.apizee.comhttps://hds.apizee.com

/api/v3/token

Query parameters

grant_typestring · enumRequired

Grant type to get access token

Default: passwordPossible values:

usernamestringOptional

Username used to login, required if grant_type is password

passwordstringOptional

Password used to login, required if grant_type is password

assertionstringOptional

JWT assertion to get access token, required if grant_type is urn:ietf:params:oauth:grant-type:jwt-bearer

Responses

200

Good case

application/json

400

400 errors

application/json

401

401 errors

application/json

403

403 errors

application/json

404

404 errors

application/json

post

/api/v3/token

HTTPcURLJavaScriptPython

POST /api/v3/token?grant_type=password HTTP/1.1
Host: cloud.apizee.com
Accept: */*

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
  "created_at": "2018-10-14T10:00:00+00:00",
  "expires_in": 86400
}

Revoke user access token

post

https://cloud.apizee.comhttps://hds.apizee.com

/api/v3/token/revoke

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Good case

application/json

post

/api/v3/token/revoke

HTTPcURLJavaScriptPython

POST /api/v3/token/revoke HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Good case

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGc..."
}