Authentication
Learn how to authenticate with the Kakiyo API
Overview
Kakiyo API uses API keys for authentication. All API requests must be authenticated using your API key in the Authorization header.
API Keys
API keys are 40-character strings that should be copied from dashboard
Obtaining an API Key
You can generate API keys from your Kakiyo dashboard:
- Log in to your Kakiyo dashboard
- Navigate to Team > API Keys
- Click Create New API Key
- Give your key a descriptive name (e.g., “Production”, “Development”, “Testing”)
- Copy your newly generated API key immediately, as you won’t be able to see it again
API keys grant access to your Kakiyo account and all associated data. Keep your keys secure and never share them publicly.
Using Your API Key
Include your API key in the Authorization header of all API requests:
API Key Best Practices
-
Never expose your API keys in client-side code, public repositories, or anywhere else that is publicly accessible.
-
Use different keys for different environments (development, staging, production).
-
Rotate your keys periodically for security. You can generate new keys and deprecate old ones from your dashboard.
-
Set appropriate permissions for each key based on what it needs to access.
-
Monitor API key usage to detect unusual patterns that might indicate a security breach.
Verifying Authentication
You can verify your API key is working correctly by making a simple request to the verification endpoint:
If successful, you’ll receive a response like:
Managing API Keys
You can manage your API keys from the Kakiyo dashboard:
- View all active keys: See a list of all your active API keys and when they were last used
- Create new keys: Generate new API keys with specific permissions
- Delete keys: Revoke access for keys that are no longer needed or may have been compromised
Error Responses
If authentication fails, you’ll receive one of the following error responses:
Status Code | Error | Description |
---|---|---|
401 | missing_api_key | No API key was provided in the request |
401 | invalid_api_key_format | The API key format is invalid |
401 | invalid_api_key | The API key is not recognized |
403 | subscription_inactive | Your subscription is inactive |
Next Steps
Now that you understand how to authenticate with the Kakiyo API, you can proceed to make API calls to create campaigns, add prospects, and more.