Skip to main content

Getting an Integrator Token

Integrator tokens allow applications to interact with our ecosystem with a single set of credentials.

Note

Chef Kitchen Management API and Back Office APIs have different, individual steps for token generation.

Follow the steps below to get an integrator token:

  1. Obtain a token by sending a POST request to /integrator/token endpoint with a key and secret_key in the body of the request. The example below shows the URL and request body:

    Integrator Token URL

    {{pb_url}}/integrator/token

    Integrator Token Request Body

    {
      "key_id": "{{key_id}}",
      "secret_key": "{{secret_key}}"
     }
    
  2. The response to this request contains a string, which serves as an authorization token for future calls to our API resources.

POST /integrator/token

Summary

Use the POST /integrator/token endpoint to generate bearer tokens for integrators.

Request Parameters

In

Field Name

Type

Required

Description

body

body

IntegratorCredentials Object

Yes

The key identifier and secret key used to obtain an integrator token

Responses

Code

Description

200

Success

Message: Token returned in response body.

401

Error

Message: Invalid credentials provided.

IntegratorCredentials Object

Field Name

Type

Required

Description

key_id

string

Yes

The key identifier for the integrator

secret_key

string

Yes

The secret key for the integrator