Skip to content

App SDK

Get OAuth token

POST /sdk/token

Request parameters

Name Type Location Description
flinkey-API-Key string header Required. API key which provides access to this API.
Authorization string header Required. The bearer token.
Content-Type string header Required. The content type of the request. Value: application/json

Request body

{
"type": "object",
  "properties": {
    "customerId": {
      "type": "number",
      "format": "int32"
    },
    "sdkKey": {
      "type": "string"
    },
    "userId": {
      "type": "number",
      "format": "int32"
    }
  } 
}

Response

200 OK

{
  "type": "object",
  "properties": {
    "id_token": {
      "type": "string"
    }
  }
}

Response

400 BAD REQUEST

Invalid combination of customerId, sdkKey and userId.

Response

401 UNAUTHORIZED

Access denied due to invalid subscription key. 
Make sure to provide a valid key for an active subscription.
{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}

Response

415 UNSUPPORTED MEDIA TYPE

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.13",
  "title": "Unsupported Media Type",
  "status": "415",
  "traceId": "<traceId>"
}

Response

500 INTERNAL SERVER ERROR

Unable to get OAuth token for <tapkeyUserId>. <exceptionMessage>
Internal Server error.