8.16 - Obter Autorização

Método "obterAutorizacao"

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Content-Type	Descrição

Endpoint	Método	Content-Type	Descrição
exemplo.com /obterAutorizacao	POST	application/json	Endpoint responsável por obter autorização de uma consulta.

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro

Obrigatório

Tipo

Descrição

idAgenda

M

Number

Id de banco de dados da consulta no seu sistema interno.

Caso seja uma consulta eletiva, esse campo irá corresponder ao valor do campo idAgenda retornado na integração de 8.6 - Gravar consulta
Caso seja uma consulta de pronto atendimento esse campo irá corresponder ao valor do campo idSenha retornado na integração de 8.9 - Pronto Atendimento - Gravar consulta

chaveUnica

M

String

Chave de identificação do usuário retornada no login

integracao

OP

Objeto

Nó integração retornado no login do usuário

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/obterAutorizacao

Body:
{
	"chaveUnica" : "101012",                
	"integracao": {
    	"xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
    },
    "idAgenda": 579,
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
autorizado	M	Boolean	Define se a autorização da consulta
mensagem	M	String	Mensagem informativa a ser ao cliente

Retorno da API - Sucesso

{
  "autorizado": false,
  "mensagem": "Sua consulta não foi autorizada"
}

{
  "autorizado": true,
  "mensagem": "Sua consulta foi autorizada"
}

Retorno da API - Falha

Atente-se as mensagens de retorno para cada HTTPS Status Code;
Siga as instruções de Descrição dos objetos e atributos de retorno - falha;