Skip to main content
Todos os endpoints da Scribe API exigem autenticação via chave de API enviada como token Bearer no header Authorization.

Tipos de chave

Ao criar uma conta de médico, são retornadas duas chaves de API:
  • Chave secreta (sk_…) — sua credencial do lado do servidor. Use-a como token Authorization: Bearer em todas as requisições desta documentação. Mantenha-a no seu backend; nunca a exponha em um navegador.
  • Chave publicável (pk_…) — uma credencial de navegador para o gravador embutível da Telepatia. É somente para troca: o embed a troca por um token de sessão de curta duração que carrega o acesso de leitura e escrita da sua conta. Uma chave pk_ não pode chamar a Scribe API diretamente — apresentá-la como token Bearer em qualquer endpoint retorna 403 permission_denied.
Salvo indicação em contrário, “chave de API” nesta documentação se refere à sua chave secreta.

Conseguindo sua chave de API

Fale com seu gerente de conta da Telepatia pra conseguir uma chave de API pra sua instituição.

Fazendo requisições autenticadas

Inclua a chave de API em cada requisição:
Veja a visão geral para a URL base.

Expiração da chave de API

Chaves de API expiram. Chaves institucionais são geradas com uma validade (padrão: 365 dias, configurável via apiKeyConfig.validForDays ao criar uma conta). Depois que uma chave passa da validade, as requisições falham com 401 e a mesma resposta “Invalid API key.” de uma chave revogada ou desconhecida. Pra restaurar o acesso, regenere a chave da conta e atualize sua integração com o novo valor.

Respostas de erro

Exemplo: Chave de API ausente

Exemplo: Chave de API inválida

Exemplo: Chave publicável usada diretamente

Uma chave publicável (pk_) não pode chamar a API diretamente — troque-a primeiro por um token de sessão, ou use sua chave secreta.