Creating an API Key
An API key is a randomly generated string that is used to authenticate your requests and allow your team to fetch data from the Dyspatch API.
How to get to the API Keys List
API keys can only be created by an Organization Administrator. The API Keys list is available by selecting API Keys from your username drop-down menu while in the Administration portal.
Create an API Key
Click Generate API Key to create your API key. Name your API key something that will help you and other Administrators identify it.
Select the key permissions level:
- Read & Write - Provides access to retrieving and posting requests via the API
- Read-only - Provides access to only retrieving requests via the API
Using an API Key
Set Bearer followed by your API key as the Authorization header in your API requests. Below is an example curl request with an API key in the Authorization header.
curl --request GET \ --url https://api.dyspatch.io/templates \ --header 'Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678' \ --header 'Accept: application/vnd.dyspatch.2019.03+json'
Refer to the Dyspatch API Documentation for more information.