API Keys
Manage your API keys to authenticate with RevenueCat
RevenueCat authenticates requests from the RevenueCat SDK and the REST API using API keys.
If you're connecting a third-party client, or building one that other developers will connect to, use OAuth instead of sharing API keys.
API Keys
There are two types of API keys:
- Public API keys (also known as SDK API keys in the dashboard) are meant to make non-potent changes to subscribers, and must be used to configure the SDK. Each app under a project is automatically provided with a public API key.
- Secret API keys, prefixed
sk_, should be kept confidential and only stored on your own servers. Your secret API keys can perform restricted API requests such as deleting subscribers and granting entitlements. Secret API keys are project-wide and can be created and revoked by project Admins.
REST API v2 Authentication
Use a secret API key to authenticate with the REST API v2:
Authorization: Bearer sk_1234567890abcdef
OAuth access tokens use the same Bearer format in the Authorization header. See Create an OAuth client.
Finding API Keys
You can find the API keys for your project under API keys in the dashboard.
Public platform-specific API keys are automatically created when adding an App to your Project and cannot be changed. Secret API keys can be created by selecting the + New secret API key button and will be listed under the section Secret API keys.
You can also find the public API key in your app settings by selecting your app from Apps.
If you cannot see your API keys anywhere in the dashboard, it may mean you do not have access to them. Contact the project's owner and make sure you are added as an Admin.
Reminder, never embed secret API keys in your app or website.
Keeping Secret API Keys Safe
Secret API keys can be used to make any API request on behalf of your RevenueCat account, such as granting entitlement access and deleting subscribers for your app. You should only create secret API keys if you need to use them and should ensure they are kept out of any publicly accessible areas such as GitHub, client-side code, and so forth.
Consider rotating your secret API keys regularly to ensure they are not compromised. Do the same when there is risk of leak (e.g. departures of employees with access to secret keys).
Adding and Revoking Secret API Keys
You can create as many secret API keys as you need, and they can be revoked at any time. When a secret API key is revoked, it's invalidated immediately and can no longer make any requests.