Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

(NOT RELEASED YET)

If API keys are required for use with BLADE requests then each use of a BLADE URL will require an API key value to be used. This feature needs to be enabled as described here: Enable API Keys .

API Key in the URL

You can send the api key value with each blade BLADE url request by simply adding it as an additional parameter to the request. The API key in the URL is used if given. The header is only checked if the key in the URL doesn’t exist or is blank.

Example: (Parameter name: api_key.
The parameter name is not case-sensitive but the key value itself is)

URL Example:

Code Block
https://tickit.com/blade/closing/group/1/Default/?format=json&api_key=1234-567-89123456

...

If the API key is not included in the URL parameters or the key does not exist then the Headers of the request are checked next. It looks for a header with the name: API-Key

The header name is not case sensitive but the API key value is case sensitive.

...