RTC authentication and API keys
Three distinct credentials
Section titled “Three distinct credentials”| Credential | Who uses it | Where it belongs |
|---|---|---|
| CHAMPREP sign-in session | A person managing the RTC console | The central sign-in and console flow |
| RTC project API key | Your application’s backend | Server-side secret storage only |
| Participant credentials | One client joining an authorized room | That 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.
Create a key
Section titled “Create a key”- In the RTC console, create a project if you have not already done so.
- Open API keys and select Create key.
- Enter a name, choose a project, and select the minimum required permissions.
- Select Create and copy the secret from the New credential dialog.
- 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.
Permission scopes
Section titled “Permission scopes”| Scope | Allows |
|---|---|
rooms:read | List rooms in the key’s project |
rooms:write | Create and end rooms in that project |
tokens:write | Issue participant credentials for an open room |
recordings:read | List project recordings and request track downloads |
recordings:write | Start and stop project recording jobs |
webhooks:read | List the project’s webhook endpoints and delivery log |
webhooks:write | Create, 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.
Call the server API
Section titled “Call the server API”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.
# 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/roomsUse 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.
Authorize your own users
Section titled “Authorize your own users”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.
Rotate and revoke
Section titled “Rotate and revoke”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.