Skip to main content
A Scribe API tem duas superfícies de integração. Elas compartilham o mesmo fluxo central de consulta — definir um contexto, executar o scribe, obter o registro. Elas diferem em quem provisiona as contas de médico e na chave com a qual você autentica.

​
API Médico

Use a API Médico quando integra para uma conta de médico que já existe. A Telepatia, ou a sua própria integração institucional, criou a conta e entregou a sua chave secreta. O fluxo é um único ciclo de consulta:
  1. Defina o contexto da consulta — dados do paciente e um Smart Template.
  2. Inicie o scribe para o clínico (ou transmita uma sessão ao vivo).
  3. Obtenha os resultados — a sessão de scribe e o documento de registro médico.
A API Médico não cria contas, filiais ou webhooks.

​
API Institucional

Use a API Institucional quando a sua plataforma provisiona e gerencia muitos médicos por conta própria. Ela é um superconjunto da API Médico: adiciona uma camada de gerenciamento, e cada médico ainda executa o fluxo Médico acima. O fluxo tem primeiro uma etapa de provisionamento, e depois o mesmo ciclo de consulta por médico:
  1. Provisione a instituição — crie contas de médico e filiais. Cada conta retorna a sua própria chave secreta de médico.
  2. Configure os controles da instituição — webhooks e auditorias, autenticados com a chave institucional.
  3. Execute cada consulta — com a chave desse médico, siga o fluxo Médico acima.

​
Qual eu uso?

Cada endpoint da API Médico também está disponível com a chave institucional. A API Institucional apenas adiciona o gerenciamento de contas, filiais, webhooks e auditorias sobre o mesmo fluxo de consulta.
Próximo: Autenticação explica os tipos de chave, e o Início rápido percorre o fluxo de consulta do início ao fim.