Obtaining an API Key
To obtain an API key for accessing the Zixflow API’s, follow these steps:-
Access the Dashboard:
- Log in to your Zixflow dashboard.
-
Generate an API Key:
- Navigate to Settings > Workspace Settings > Developer > API Key.
- Navigate to Settings > Workspace Settings > Developer > API Key.
-
Configure API Key Settings:
- When generating an API key, you can configure the following settings:
-
Permissions:
- Specify the level of access you want to grant to the API key. You can define which API endpoints and actions the key is allowed to perform.
-
Expiry (Optional):
- Optionally, set an expiration date for the API key. If set, the key will no longer be valid after the specified date.
-
IP Restriction (Optional):
- Optionally, restrict API key usage to specific IP addresses. This enhances security by only allowing requests from designated IPs.
-
Generate the API Key:
- After configuring your desired settings, click the “Generate” or “Create” button to generate the API key.
-
Receive the API Key:
- Once generated, you will receive your API key, which you will use to authenticate your API requests.
Using the API Key as a Bearer Token
To authenticate your API requests using the API key as a Bearer token, include it in theAuthorization
header as follows:
your_api_key
with the actual API key you generated.