Aller au contenu
Documentation

Authentification RTC et clésAPI

IdentifiantQui l’utiliseÀ sa place
CHAMPREP session de connexionUne personne chargée de la gestion de la console RTCLe flux central de connexion et de console
CléAPI de projet RTCLe backend de votre applicationStockage des secrets exclusivement côté serveur
Identifiants des participantsUn client rejoignant une salle autoriséeLe flux de connexion actif de ce client

Ne remplacez jamais une clé de projet par la session de votre compte principal dans une intégration. N’envoyez jamais de clé de projet au JavaScript du navigateur, aux paquets mobiles, aux dépôts de code source, aux outils d’analyse, aux journaux ou aux URL publiques.

  1. Dans la console RTC, créez un projet si vous ne l’avez pas déjà fait.
  2. Ouvrir API clés et sélectionnez Créer une clé.
  3. Saisissez un nom, choisissez un projet et sélectionnez les autorisations minimales requises.
  4. Sélectionnez Créer et copiez le secret à partir du Nouvelles informations d’identification dialogue.
  5. Stockez-la dans le gestionnaire de secrets côté serveur de votre application.

Le secret complet n’est affiché qu’au moment de la création. La console actuelle crée des clés dont la durée de validité est de 90 jours. Elle ne propose pas d’éditeur permettant de modifier cette durée. Si vous perdez le secret ou s’il arrive à expiration, créez-en un nouveau ; aucune liste de clés ne permet de le récupérer.

PortéeAutorise
rooms:readRépertorier les salles du projet associé à la clé
rooms:writeCréer et fermer des salles dans ce projet
tokens:writeÉmettre les identifiants des participants pour une salle ouverte
recordings:readRépertorier les enregistrements du projet et demander le téléchargement des pistes
recordings:writeDémarrer et arrêter les tâches d’enregistrement de projet
webhooks:readRépertoriez les points de terminaison des webhooks du projet et le journal de livraison
webhooks:writeCréez, modifiez, testez et rejouez les points de terminaison des webhooks du projet

Un backend qui génère des appels a généralement besoin de rooms:write, tokens:write, et rooms:read. N’accordez les autorisations d’enregistrement qu’en cas de nécessité. Les clés de projet ne peuvent pas créer d’organisations, créer de projets, gérer des clés ou des clés de signature, ni administrer la plateforme. Utilisez la console pour ces tâches de configuration client. Avec les périmètres des webhooks, une clé ne gère que les points de terminaison de son propre projet.

Une clé appartient à un seul et même projet. La modification projectId La présence d’une clé dans une requête ne lui permet pas d’accéder à un autre projet. Les limites d’accès et d’utilisation des fonctionnalités restent applicables ; le fait de disposer d’une clé valide ne permet pas de contourner l’abonnement.

La baseAPI de clients de production de RTC est https://api.rtc.champrep.com. Elle est distincte de la passerelle API CHAMPREP générale etCHAMPREPAPI Gateway utilise des clés RTC.

Fenêtre 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

Utilisez le protocole HTTPS et des corps de requête au format JSON. N’insérez pas la clé dans les chaînes de requête. Le navigateur doit appeler votre backend, qui appelle ensuite RTC ; il ne doit pas appeler directement les points de terminaison de gestion avec la clé du serveur.

Avant de délivrer les identifiants des participants, votre backend doit vérifier la session de votre utilisateur et son autorisation à rejoindre la salle spécifique. Associez la salle de votre application à sa salle RTC sur le serveur. Ne faites pas confiance aux identifiants de salle ou de projet arbitraires soumis par le client, même si la clé peut y accéder.

Le Point de terminaison des jetons renvoie un ensemble d’identifiants temporaires. Émettez un nouvel ensemble pour chaque participant et chaque reconnexion. canPublish: false rende un participant en mode « réception uniquement ». Un jeton ne remplace pas les vérifications d’adhésion de votre application. Pour créer un accès de participant sans APIappel par adhésion, utilisez joindre les jetons signée avec une clé de signature de projet.

Créez une nouvelle clé avec les périmètres requis, mettez à jour le stockage des secrets de votre serveur, vérifiez l’intégration, puis sélectionnez Révoquer la clé sur l’ancienne clé. Révoquez-la immédiatement si un secret est divulgué. La révocation bloque les demandes ultérieures et invalide les autorisations de téléchargement émises par cette clé ; ne supposez pas qu’elle déconnecte un participant déjà rejoint. Mettez fin à une salle concernée pour interrompre ses sessions.

N’envoyez jamais vos identifiants au service d’assistance. Partagez plutôt l’opération, l’horodatage, le statut HTTP et une erreur expurgée.