Pular para o conteúdo

Autenticação

Toda requisição à API do Record Meeting precisa de uma chave de API. Você cria chaves no app em Configurações ➤ Chaves de API.

A aba Chaves de API das Configurações com o botão Criar chave

https://api.recordmeeting.com/v1

Os caminhos dos endpoints nesta referência são escritos com o prefixo /v1, por exemplo GET /v1/recordings. Adicione-os a https://api.recordmeeting.com.

Envie sua chave de API no cabeçalho Authorization. As chaves começam com sk_rm_.

Authorization: Bearer sk_rm_your_key

Para criar uma chave, consulte Guia do usuário ➤ Chaves de API. Uma chave tem o mesmo acesso que sua conta: suas próprias gravações e as gravações da organização que você tem permissão para ver.

Terminal window
curl "https://api.recordmeeting.com/v1/recordings" \
-H "Authorization: Bearer sk_rm_your_key"

As respostas bem-sucedidas são JSON com o resultado em data. Endpoints de lista que paginam seus resultados adicionam um objeto pagination. Algumas respostas também trazem "success": true.

Requisições PATCH e DELETE respondem 204 No Content com corpo vazio quando são bem-sucedidas.

Todos os erros têm este formato:

{
"error": {
"code": "ERROR_CODE",
"message": "Human readable description"
}
}

Uma requisição sem um cabeçalho Authorization válido recebe 401.

CódigoStatus HTTPSignificado
INVALID_API_KEY401A chave não existe ou foi revogada
API_KEY_EXPIRED401A chave expirou
USER_NOT_FOUND401A conta à qual a chave pertence não existe mais
AUTH_ERROR401Falha na autenticação
CódigoStatus HTTPSignificado
VALIDATION_ERROR400Parâmetros de requisição inválidos ou ausentes
RECORDING_NOT_READY400A gravação ainda não pode ser compartilhada
ORGANIZATION_SUBSCRIPTION_EXPIRED402A organização proprietária da gravação não tem mais uma assinatura Enterprise ativa
FORBIDDEN403Você não é membro da organização ou não tem permissão para ver o que solicitou
RECORDING_LOCKED403A gravação está bloqueada. Faça upgrade para abri-la
SUBSCRIPTION_REQUIRED403A ação exige um plano pago
TRANSCRIPT_NOT_AVAILABLE403A transcrição está desativada para a organização ou para o membro
SHARING_DISABLED403O compartilhamento está desativado para a organização ou para o membro
RECORDING_NOT_FOUND404A gravação não existe ou você não pode acessá-la
INTERNAL_ERROR500Erro no servidor