Skip to content
Documentation

RTC authentication and API keys

CredentialWho uses itWhere it belongs
CHAMPREP sign-in sessionA person managing the RTC consoleThe central sign-in and console flow
RTC project API keyYour application’s backendServer-side secret storage only
Participant credentialsOne client joining an authorized roomThat client’s active join flow

Never substitute your primary account session for a project key in an integration. Never send a project key to browser JavaScript, mobile bundles, source repositories, analytics, logs, or public URLs.

  1. In the RTC console, create a project if you have not already done so.
  2. Open API keys and select Create key.
  3. Enter a name, choose a project, and select the minimum required permissions.
  4. Select Create and copy the secret from the New credential dialog.
  5. Store it in your application’s server-side secret manager.

The full secret is shown only at creation. The current console creates keys with a 90-day expiry. It does not expose an expiry editor. If you lose the secret or it expires, create a replacement; a list of keys cannot recover it.

ScopeAllows
rooms:readList rooms in the key’s project
rooms:writeCreate and end rooms in that project
tokens:writeIssue participant credentials for an open room
recordings:readList project recordings and request track downloads
recordings:writeStart and stop project recording jobs
webhooks:readList the project’s webhook endpoints and delivery log
webhooks:writeCreate, change, test and replay the project’s webhook endpoints

A backend that creates calls typically needs rooms:write, tokens:write, and rooms:read. Add recording permissions only where needed. Project keys cannot create organizations, create projects, manage keys or signing keys, or administer the platform. Use the console for those customer setup tasks. With the webhook scopes, a key manages only its own project’s endpoints.

A key belongs to exactly one project. Changing projectId in a request does not let it access another project. Plan access and feature allowances still apply; possessing a valid key is not a subscription bypass.

RTC’s production customer API base is https://api.rtc.champrep.com. It is separate from the general CHAMPREP API Gateway and uses RTC keys.

Terminal window
# Set RTC_API_KEY securely in your server environment before running this.
curl --fail-with-body \
--header "Authorization: Bearer $RTC_API_KEY" \
https://api.rtc.champrep.com/v1/rooms

Use HTTPS and JSON bodies. Do not put the key in query strings. The browser should call your backend, which then calls RTC; it should not directly call management endpoints with the server key.

Before issuing participant credentials, your backend must verify your user’s session and permission to join the specific room. Map your application room to its RTC room on the server. Do not trust arbitrary room or project IDs submitted by the client, even if the key can access them.

The token endpoint returns a temporary credential set. Issue a fresh set for each participant and each reconnection. canPublish: false makes a participant receive-only. A token does not replace your application’s membership checks. To mint participant access without an API call per join, use join tokens signed with a project signing key.

Create a new key with the needed scopes, update your server’s secret storage, verify the integration, then select Revoke key on the old key. Revoke immediately if a secret is exposed. Revocation blocks subsequent requests and invalidates download grants issued by that key; do not assume it disconnects an already joined participant. End an affected room to terminate its sessions.

Never send credentials to support. Share the operation, timestamp, HTTP status, and a redacted error instead.