Pular para o conteúdo
Documentation

Autenticação RTC e chavesAPI

CredencialQuem a utilizaOnde ela deve ser colocada
CHAMPREP sessão de loginUma pessoa que gerencia o console do RTCO fluxo central de login e do console
APIChave do projeto RTCO back-end do seu aplicativoArmazenamento de segredos exclusivamente no lado do servidor
Credenciais dos participantesUm cliente ingressando em uma sala autorizadaO fluxo de adesão ativo desse cliente

Nunca substitua a sessão da sua conta principal por uma chave de projeto em uma integração. Nunca envie uma chave de projeto para o JavaScript do navegador, pacotes móveis, repositórios de código-fonte, análises, logs ou URLs públicas.

  1. No console da RTC, crie um projeto, caso ainda não o tenha feito.
  2. Abrir API chaves e selecione Crie uma chave.
  3. Insira um nome, escolha um projeto e selecione as permissões mínimas necessárias.
  4. Selecione Criar e copie o segredo do Nova credencial caixa de diálogo.
  5. Armazene-a no gerenciador de segredos do lado do servidor do seu aplicativo.

O segredo completo é exibido apenas no momento da criação. O console atual cria chaves com validade de 90 dias. Ele não disponibiliza um editor de validade. Caso perca o segredo ou ele expire, crie um substituto; uma lista de chaves não permite recuperá-lo.

EscopoPermite
rooms:readListar salas no projeto da chave
rooms:writeCrie e encerre salas nesse projeto
tokens:writeEmitir credenciais de participantes para uma sala aberta
recordings:readListar gravações do projeto e solicitar downloads de faixas
recordings:writeInicie e interrompa tarefas de gravação do projeto
webhooks:readListe os endpoints de webhook do projeto e o registro de entrega
webhooks:writeCrie, altere, teste e reproduza os endpoints de webhook do projeto

Um back-end que gera chamadas normalmente precisa rooms:write, tokens:write, e rooms:read. Adicione permissões de gravação apenas quando necessário. As chaves de projeto não podem criar organizações, criar projetos, gerenciar chaves ou chaves de assinatura, nem administrar a plataforma. Utilize o console para essas tarefas de configuração do cliente. Com os escopos de webhook, uma chave gerencia apenas os endpoints do seu próprio projeto.

Uma chave pertence a exatamente um projeto. Alterar projectId A presença de uma chave em uma solicitação não permite o acesso a outro projeto. Os limites de acesso e de recursos ainda se aplicam; possuir uma chave válida não constitui uma forma de contornar a assinatura.

A baseAPI de clientes de produção da RTC é https://api.rtc.champrep.com. Ela é independente do geral eCHAMPREPAPI Gateway utiliza chaves RTC.

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

Utilize HTTPS e corpos JSON. Não coloque a chave em strings de consulta. O navegador deve chamar seu backend, que então chama o RTC; ele não deve chamar diretamente os pontos de extremidade de gerenciamento com a chave do servidor.

Antes de emitir credenciais de participante, seu backend deve verificar a sessão do usuário e sua permissão para ingressar na sala específica. Mapeie a sala do seu aplicativo para a respectiva sala do RTC no servidor. Não confie em IDs arbitrários de sala ou projeto enviados pelo cliente, mesmo que a chave tenha acesso a eles.

O ponto de extremidade de token retorna um conjunto de credenciais temporárias. Emita um novo conjunto para cada participante e a cada reconexão. canPublish: false torna um participante apenas receptor. Um token não substitui as verificações de adesão do seu aplicativo. Para gerar acesso de participante sem uma API chamada por adesão, utilize token de junção assinado com uma chave de assinatura do projeto.

Crie uma nova chave com os escopos necessários, atualize o armazenamento de segredos do seu servidor, verifique a integração e, em seguida, selecione Revogar chave na chave antiga. Revogue imediatamente caso um segredo seja exposto. A revogação bloqueia solicitações subsequentes e invalida autorizações de download emitidas por essa chave; não presuma que ela desconecte um participante já conectado. Encerre uma sala afetada para interromper suas sessões.

Nunca envie credenciais ao suporte técnico. Em vez disso, compartilhe a operação, o carimbo de data/hora, o status HTTP e um erro com informações ocultadas.