Introduction

The Redokun API is an HTTP API. It authenticates each call with an API key, uses standard HTTP methods and status codes, and answers in JSON.

Base URLCopy Anchor Link

https://api.redokun.com/v1

Call the API over HTTPS.

Your first callCopy Anchor Link

Check that your API key works with GET /v1/me, which returns the account the key acts as:

curl https://api.redokun.com/v1/me \
  -H "Authorization: Bearer rdk_..."

{
  "account": {
    "id": 123,
    "name": "Jane Doe"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://api.redokun.com/v1/me"
    }
  ]
}

ResponsesCopy Anchor Link

Every response, errors included, has a JSON body and the header Content-Type: application/json.

Calls from a browserCopy Anchor Link

The API sends no CORS headers, so a browser cannot call it. Call it from your server, and keep the API key there.

AccessCopy Anchor Link

The Redokun API is a paid service. Check that your plan includes it: if it does, the team leader sees Public API in the Redokun settings. For more information, write to support@redokun.com.

Once the API is in your plan, the team leader gets the API key from the settings.