Create API Key

POST 
/auth/key

Use endpoint POST /auth/key to get an appKey for your application. You can create a new key at any time. Creating a new key renders the old key unusable. This is required and only used for /auth/token.

Request

application/json

Body

data

object

required

A key for grouping different types of API data.

type APIcallType (string)

This API call type. This call must be auth.

Default value: auth

Example: auth

attributes

object

A key for grouping data.

appId appId (string)

Supplied by Digitzs on onboarding.

Responses

201

Created

application/json

Schema

Schema

links

object

self string

URL for the current resource.

data

object

type string

Type of the response data.

id string

The same x-api-key used in the Header.

attributes

object

appKey appKey (string)

The key used to create an appToken with /auth/token.

Example (from schema)

{
  "links": {
    "self": "string"
  },
  "data": {
    "type": "string",
    "id": "string",
    "attributes": {
      "appKey": "string"
    }
  }
}

Result

{
  "links": {
    "self": "xxxx/auth/key"
  },
  "data": {
    "type": "auth",
    "id": "xxxx",
    "attributes": {
      "appKey": "xxxx"
    }
  }
}