AMHP Desenvolvedores

Autenticação

Login

Obtém o token de acesso utilizado pelas requisições protegidas da API.

POST/api/auth/oauth

Autorização

Auth typeNo Auth

Esta requisição não utiliza Bearer Token.

Cabeçalhos

Content-Typestringobrigatório

Valor application/json.

x-api-keystringobrigatório

Chave da API representada por {{X_API_KEY}}.

Corpo da requisição

ApplicationIdstringobrigatório

Valor da variável {{userId}}.

CustomerIdstringobrigatório

Valor da variável {{secret}}.

curl --request POST \
  --url '{{API_BASE_URL}}/api/auth/oauth' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {{X_API_KEY}}' \
  --data '{
    "ApplicationId": "{{userId}}",
    "CustomerId": "{{secret}}"
  }'

RespostaEstrutura variável

O formato da resposta depende do resultado do processamento. Consulte os códigos HTTP mapeados abaixo.

Possíveis respostas

Status200

RetornoAutenticado

Token de acesso emitido com sucesso.

Atendimento

Criação de atendimento

Registra um novo atendimento para processamento no sistema da AMHP.

POST/api/atendimento/adicionar-pre-guia

Contrato

O contrato completo deste endpoint ainda está em validação. Os campos serão exibidos assim que forem liberados para integração.

Possíveis respostas

Status200

RetornoProcessado

Pré-guia recebida e processada.

Extrato

Extrato completo

Retorna o faturamento completo da clínica de acordo com a quinzena informada.

GET/api/extrato/{tipoNegociacao}/obter-extrato-completo/{referenciaId}

Autorização e cabeçalhos

AuthorizationBearer Tokenobrigatório

Token da variável {{BEARER_TOKEN}}.

x-api-keystringobrigatório

Chave da API representada por {{X_API_KEY}}.

Parâmetros de rota

tipoNegociacaostringobrigatório

Valor de exemplo: normal.

referenciaIdstringobrigatório

Valor de exemplo: 551.

curl --request GET \
  --url '{{API_BASE_URL}}/api/extrato/normal/obter-extrato-completo/551' \
  --header 'Authorization: Bearer {{BEARER_TOKEN}}' \
  --header 'x-api-key: {{X_API_KEY}}'

RespostaEstrutura variável

O formato da resposta depende do resultado do processamento. Consulte os códigos HTTP mapeados abaixo.

Possíveis respostas

Status200

RetornoSucesso

Extrato completo retornado.