RTC-Authentifizierung und SchlüsselAPI
Drei unterschiedliche Zugangsdaten
Abschnitt betitelt „Drei unterschiedliche Zugangsdaten“| Anmeldeinformationen | Wer verwendet sie | Wo es hingehört |
|---|---|---|
| CHAMPREP Anmeldesitzung | Eine Person, die die RTC-Konsole verwaltet | Der zentrale Anmelde- und Konsolenablauf |
| RTC-Projekt-SchlüsselAPI | Das Backend Ihrer Anwendung | Ausschließlich serverseitige Speicherung von Geheimnissen |
| Anmeldedaten der Teilnehmer | Ein Client, der einem autorisierten Raum beitritt | Der aktive Beitrittsablauf dieses Clients |
Ersetzen Sie in einer Integration niemals einen Projektschlüssel durch Ihre primäre Kontositzung. Senden Sie einen Projektschlüssel niemals an Browser-JavaScript, mobile Bundles, Quellcode-Repositorys, Analysetools, Protokolle oder öffentliche URLs.
Schlüssel erstellen
Abschnitt betitelt „Schlüssel erstellen“- Erstellen Sie in der RTC-Konsole ein Projekt, falls Sie dies noch nicht getan haben.
- Öffnen API Schlüssel und wählen Sie Schlüssel erstellen.
- Geben Sie einen Namen ein, wählen Sie ein Projekt aus und legen Sie die minimal erforderlichen Berechtigungen fest.
- Wählen Sie Erstellen und kopieren Sie das Geheimnis aus dem Neue Anmeldedaten Dialog.
- Speichern Sie ihn im serverseitigen Geheimnismanager Ihrer Anwendung.
Der vollständige Geheimcode wird nur bei der Erstellung angezeigt. Die aktuelle Konsole erstellt Schlüssel mit einer Gültigkeitsdauer von 90 Tagen. Sie bietet keinen Editor zur Änderung der Gültigkeitsdauer. Sollten Sie den Geheimcode verlieren oder sollte er ablaufen, erstellen Sie einen Ersatz; eine Liste der Schlüssel ermöglicht keine Wiederherstellung.
Berechtigungsbereiche
Abschnitt betitelt „Berechtigungsbereiche“| Gültigkeitsbereich | Erlaubt |
|---|---|
rooms:read | Räume im Projekt des Schlüssels auflisten |
rooms:write | Erstellen und schließen Sie Räume in diesem Projekt |
tokens:write | Stellen Sie Teilnehmerzugangsdaten für einen offenen Raum aus |
recordings:read | Projektaufzeichnungen auflisten und Track-Downloads anfordern |
recordings:write | Projekt-Aufzeichnungsaufträge starten und beenden |
webhooks:read | Listen Sie die Webhook-Endpunkte und das Zustellungsprotokoll des Projekts auf |
webhooks:write | Erstellen, ändern, testen und wiederholen Sie die Webhook-Endpunkte des Projekts |
Ein Backend, das Aufrufe generiert, benötigt in der Regel rooms:write, tokens:write, und rooms:read. Erteilen Sie Aufzeichnungsberechtigungen nur dort, wo sie benötigt werden. Projekt-Schlüssel können keine Organisationen oder Projekte erstellen, keine Schlüssel oder Signaturschlüssel verwalten und die Plattform nicht verwalten. Nutzen Sie für diese Aufgaben zur Kundeneinrichtung die Konsole. Bei den Webhook-Bereichen verwaltet ein Schlüssel nur die Endpunkte seines eigenen Projekts.
Ein Schlüssel gehört genau zu einem Projekt. Eine Änderung projectId in einer Anfrage gewährt keinen Zugriff auf ein anderes Projekt. Die Zugangs- und Funktionsbeschränkungen gelten weiterhin; der Besitz eines gültigen Schlüssels stellt keine Umgehung des Abonnements dar.
Aufruf des Servers API
Abschnitt betitelt „Aufruf des Servers API“Die Produktions-Kunden-APIAPI von RTC ist https://api.rtc.champrep.com. Sie ist vom allgemeinen API-Gateway getrennt undCHAMPREPAPI Gateway verwendet RTC-Schlüssel.
# 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/roomsVerwenden Sie HTTPS und JSON-Inhalte. Geben Sie den Schlüssel nicht in Abfragezeichenfolgen an. Der Browser sollte Ihr Backend, das anschließend RTC aufruft; es sollte nicht direkt Verwaltungsendpunkte mit dem Serverschlüssel aufrufen.
Autorisieren Sie Ihre eigenen Benutzer
Abschnitt betitelt „Autorisieren Sie Ihre eigenen Benutzer“Bevor Sie Teilnehmer-Anmeldedaten ausstellen, muss Ihr Backend die Sitzung Ihres Benutzers sowie dessen Berechtigung zur Teilnahme an dem jeweiligen Raum überprüfen. Ordnen Sie den Raum Ihrer Anwendung dem entsprechenden RTC-Raum auf dem Server zu. Vertrauen Sie keinen beliebigen Raum- oder Projekt-IDs, die vom Client übermittelt werden, selbst wenn der Schlüssel darauf zugreifen kann.
Die Token-Endpunkt gibt einen temporären Satz von Zugangsdaten zurück. Stellen Sie für jeden Teilnehmer und jede erneute Verbindung einen neuen Satz aus. canPublish: false macht einen Teilnehmer zu einem reinen Empfänger. Ein Token ersetzt nicht die Mitgliedschaftsprüfungen Ihrer Anwendung. Um Teilnehmerzugriff ohne einen AufrufAPI pro Beitritt zu gewähren, verwenden Sie Join-Token signiert mit einem Projekt-Signaturschlüssel.
Rotieren und widerrufen
Abschnitt betitelt „Rotieren und widerrufen“Erstellen Sie einen neuen Schlüssel mit den erforderlichen Gültigkeitsbereichen, aktualisieren Sie den geheimen Speicher Ihres Servers, überprüfen Sie die Integration und wählen Sie anschließend Schlüssel widerrufen auf den alten Schlüssel. Widerrufen Sie diesen unverzüglich, wenn ein Geheimnis offengelegt wurde. Der Widerruf blockiert nachfolgende Anfragen und macht die von diesem Schlüssel erteilten Download-Berechtigungen ungültig; gehen Sie nicht davon aus, dass dadurch die Verbindung eines bereits beigetretenen Teilnehmers getrennt wird. Beenden Sie einen betroffenen Raum, um dessen Sitzungen zu beenden.
Senden Sie niemals Anmeldedaten an den Support. Teilen Sie stattdessen den Vorgang, den Zeitstempel, den HTTP-Status sowie einen anonymisierten Fehler mit.