Pular para o conteúdo
ampli prescreve
V1 V2
Referência da API V1

Todas as operações

Contrato da integração V1 em https://devapiprescriptions.amplimed.cloud. Para o passo a passo, use o guia.

Baixar .md

Como este contrato é mantido

O contrato da V1 não está mais disponível para novas integrações.

Autenticação

POST /partners/authenticate
v1.partners.authenticate #

Troca as credenciais do parceiro por um token de acesso de curta duração, usado como Bearer token em POST /partners/attendance.

Requisição

Campo Tipo Detalhes
clientId string
obrigatório

Identificador do parceiro, fornecido pela Amplimed.
clientSecret string
obrigatório

Segredo do parceiro. Na V1 o campo chama-se clientSecret; na V2 passou a ser secretKey.

200 Token de acesso do parceiro.

Campo Tipo Detalhes
access_token string
obrigatório

Token de acesso do parceiro.
token_type string
obrigatório

Tipo do token, usado para montar o header Authorization.
expires_at string
obrigatório

Momento de expiração do token, no formato Y-m-d H:i:s.

Atendimento

POST /partners/attendance
v1.partners.attendance requer Bearer token #

Cria o atendimento com o contexto do profissional e do paciente e devolve a URL que o parceiro carrega no iframe da prescrição. Requer o token de acesso emitido em POST /partners/authenticate.

Requisição

Campo Tipo Detalhes
id_profissional string
obrigatório

Identificador do profissional na Amplimed.
embedded_type string
obrigatório coupled suspended

Modo de incorporação: coupled renderiza o iframe no fluxo da página; suspended abre em camada flutuante.
paciente object
obrigatório

Dados do paciente do atendimento. A integração de referência envia todos os campos abaixo; a obrigatoriedade individual de cada um não está formalizada no contrato da V1.
paciente.nome string
opcional
paciente.documento string
opcional
paciente.tipo_documento string
opcional

Tipo do documento enviado, por exemplo CPF.
paciente.data_nascimento string
opcional

Data de nascimento no formato Y-m-d.
paciente.sexo_biologico string
opcional
paciente.celular string
opcional

Telefone celular com código do país e DDD, somente dígitos.
paciente.cidade string
opcional
paciente.estado string
opcional

Sigla da unidade federativa.
paciente.email string email
opcional

200 Atendimento criado.

Campo Tipo Detalhes
url string
obrigatório

URL da prescrição embarcada, carregada pelo parceiro no src do iframe.