Concepts
API keys
API keys are used to authenticate requests to our application programming interface (API) on behalf of your account.
They should be kept secret, as they provide access to portions of your account.
You can create and manage API keys here.
Scopes
API keys can be created with different levels of permission, known as scopes.
Select the minimum scope necessary for your use case.
| Scope | Description |
|---|---|
| Read analytics | Allows read-only access to analytics data. |
| Automate payments | Allows creating invoices and receiving payment events. |
| Full control | Allows full access to your account, including creating and managing API keys and notifications. |
When you create an API key, you will be shown the key value only once. Be sure to copy it and store it securely.
Usage
When you see <API Key> in our API documentation, replace it with your actual API key.
Security practices
If you believe an API key has been compromised, you can delete it and create a new one.
See Manage API Keys.