Skip to main content
How to obtain an API Key

Geenrate and obtain an API key from Rayn Console

Niels Baarsma avatar
Written by Niels Baarsma
Updated over a week ago

How to Obtain an API Key for Rayn API

When working with the Rayn API, you will need an API key to authenticate. The API key is always associated with a connection that can be created in the management console.

To obtain an API key, go to Air -> Connections in the left-hand menu. API keys are associated with the server-side connection type. If you do not have a server-side connection yet, you can create one by clicking "New" and selecting "RaynSS". Enter a name for the connection. If you are only using the API, you can simply click "Finish," which will skip the rest of the setup for content ingestion. The connection is now created. Click on the respective connection and navigate to the "API Keys" tab. If the API key has not been created yet, click "Generate". All API end points use the same key.

There is only one supported API key per connection. In case you hit "generate" when there is an existing API key then it will be overwritten and invalidated within 10 minutes.

For API reference documentation head over to the developer docs.

For more information on how to set up content ingestion or user data via batch upload check out this article.

Did this answer your question?