Authentication

Getting an API key

You can create an API key on the API Integrations  page in the Ignite Admin UI. You need an admin role to access this page.

When you create a key, choose its permissions and an optional category scope.

Permissions

API key permissions are granted per resource. Enable only the actions that your integration needs.

API keys cannot manage members, webhooks, other API integrations, or account settings.

Category scope

You can limit an API key to one or more categories. If you select categories, the key can only access videos in those categories and their subcategories. If you leave the field empty, the key can access all categories in the workspace.

Category scope applies to videos and to per-video analytics calls. It does not limit live event access.

Using an API key

Pass your API key as a Bearer token in the Authorization header of your request.

curl -X GET https://app.ignitevideo.cloud/api/videos \
-H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://app.ignitevideo.cloud/api/videos', {
headers: {
  Authorization: `Bearer YOUR_API_KEY`
}
});

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://app.ignitevideo.cloud/api/videos', [
'headers' => [
  'Authorization' => 'Bearer YOUR_API_KEY'
]
]);