Ir al contenido
Documentation

Autenticación RTC y clavesAPI

CredencialQuién las utilizaDónde corresponde
CHAMPREP Sesión de inicio de sesiónUna persona que gestione la consola de RTCEl flujo central de inicio de sesión y la consola
ClaveAPI del proyecto RTCEl backend de su aplicaciónAlmacenamiento de secretos únicamente en el lado del servidor
Credenciales de los participantesUn cliente que se une a una sala autorizadaEl flujo de incorporación activo de ese cliente

Nunca sustituya la sesión de su cuenta principal por una clave de proyecto en una integración. Nunca envíe una clave de proyecto al JavaScript del navegador, a paquetes móviles, a repositorios de código fuente, a herramientas de análisis, a registros ni a URL públicas.

  1. En la consola de RTC, cree un proyecto si aún no lo ha hecho.
  2. Abrir API claves y seleccione Crear clave.
  3. Introduzca un nombre, elija un proyecto y seleccione los permisos mínimos necesarios.
  4. Seleccione Crear y copie el secreto del Nueva credencial diálogo.
  5. Guárdela en el gestor de secretos del lado del servidor de su aplicación.

El secreto completo solo se muestra en el momento de la creación. La consola actual crea claves con una caducidad de 90 días. No dispone de un editor de caducidad. Si pierde el secreto o este caduca, cree uno nuevo; no es posible recuperarlo a partir de una lista de claves.

Ámbito de aplicaciónPermite
rooms:readEnumerar salas en el proyecto de la clave
rooms:writeCree y cierre salas en ese proyecto
tokens:writeEmitir credenciales de participante para una sala abierta
recordings:readEnumerar las grabaciones del proyecto y solicitar descargas de pistas
recordings:writeInicie y detenga los trabajos de grabación del proyecto
webhooks:readEnumere los puntos finales de webhook del proyecto y el registro de entrega
webhooks:writeCree, modifique, pruebe y reproduzca los puntos finales de webhook del proyecto

Un backend que genera llamadas suele necesitar rooms:write, tokens:write, y rooms:read. Añada permisos de grabación solo cuando sea necesario. Las claves de proyecto no pueden crear organizaciones, crear proyectos, gestionar claves o claves de firma, ni administrar la plataforma. Utilice la consola para esas tareas de configuración del cliente. Con los ámbitos de webhook, una clave gestiona únicamente los puntos de conexión de su propio proyecto.

Una clave pertenece a un único proyecto. Al cambiar projectId La inclusión de una clave en una solicitud no le permite acceder a otro proyecto. Los límites de acceso y de funciones del plan siguen siendo aplicables; disponer de una clave válida no supone eludir la suscripción.

La baseAPI de clientes de producción de RTC es https://api.rtc.champrep.com. Es independiente de la general yCHAMPREPAPI Gateway utiliza claves de RTC.

Ventana de terminal
# 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

Utilice HTTPS y cuerpos JSON. No incluya la clave en cadenas de consulta. El navegador debe llamar a su backend, que a su vez llama a RTC; no debe llamar directamente a los puntos finales de gestión con la clave del servidor.

Antes de emitir las credenciales de los participantes, su backend debe verificar la sesión del usuario y su permiso para unirse a la sala específica. Asigne la sala de su aplicación a su sala RTC en el servidor. No confíe en los ID de sala o de proyecto arbitrarios enviados por el cliente, aunque la clave pueda acceder a ellos.

El punto final de tokens Devuelve un conjunto de credenciales temporales. Emita un nuevo conjunto para cada participante y cada reconexión. canPublish: false hace que un participante tenga acceso solo de recepción. Un token no sustituye a las comprobaciones de pertenencia de su aplicación. Para generar acceso de participante sin una llamadaAPI por cada incorporación, utilice tokens de unión firmado con una clave de firma del proyecto.

Cree una nueva clave con los ámbitos necesarios, actualice el almacenamiento de secretos de su servidor, verifique la integración y, a continuación, seleccione Revocar clave en la clave antigua. Revoque inmediatamente si se filtra un secreto. La revocación bloquea las solicitudes posteriores e invalida las autorizaciones de descarga emitidas por esa clave; no dé por sentado que desconecta a un participante que ya se haya unido. Cierre una sala afectada para poner fin a sus sesiones.

Nunca envíe credenciales al servicio de asistencia técnica. En su lugar, comparta la operación, la marca de tiempo, el estado HTTP y un error censurado.