API Key Authentication
Learn how to use API Keys to connect to third-party services in ByteChef
API Key Authentication
API Key authentication is a simple way to authenticate with many third-party services. An API key is a unique identifier used to authenticate a user, developer, or calling program to an API.
How it Works
When you use an API key, ByteChef includes the key in the header or as a query parameter in every request made to the service's API.
Example header:
X-API-Key: abcdef12345
Example query parameter:
?api_key=abcdef12345
Finding Your API Key
API keys are usually found in the settings or developer dashboard of the service you want to connect to. Look for sections named:
- API Settings
- Developer Tools
- Security
- Integrations
Setting Up API Key Connections
To set up an API key connection in ByteChef:
- Go to the Connections tab.
- Click New Connection and select a service that uses API Keys.
- Enter your API Key in the provided field.
- Some services may also require an API Secret or an App ID.
- Click Save to create the connection.
Security
API keys should be treated with the same level of security as passwords. ByteChef encrypts all stored API keys using AES-256 at rest to ensure they are protected.
Related: Troubleshooting API Keys
How is this guide?
Last updated on