8.13 - Cabine de atendimento
- Everson Delmaschio
- Ranniêr Reis
Índice
Só são suportadas integrações no padrão REST.
Orientações
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.
Critérios de preenchimento
Abreviação | Nome | Descrição |
|---|---|---|
M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
Objetos e atributos de retorno
Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração.
Exemplo do atributo “contratos”:
Contrato
contrato
Contratos
contratos
Método de detalheConsultaAnexo
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
http://exemplo.com /cabineAtendimento/detalhes
| POST | application/json | Endpoint para retornar as informações da cabine de atendimento |
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 |
|---|---|---|---|
idCabine | M | String | Id de banco de dados no seu sistema interno. |
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
integracao | OP | Objeto | Nó integração retornado no login do usário |
{
"chaveUnica":"String",
"integracao":{ Objeto },
"idCabine":"String",
}
Exemplo request
url:
https://www.operadoradesaude.com.br/mobilesaude/cabineAtendimento
Body:
{
"chaveUnica": "101012",
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"idCabine": "eyJ0ZXN0ZSI6MTIzCn0",
}
Descrição dos objetos e atributos de retorno - Sucesso
Está indicado abaixo a estrutura de retorno do seu método login. 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 |
|---|---|---|---|---|
titulo | M | String | url do documento em .pdf | Obrigatório quando base64 não for informado.
|
subtitulo | M | String | base64 do documento em .pdf | Obrigatório quando url não for informado. texto livre |
descricao | M | String | MIME TYPE do arquivo: | Obrigatório quando base64 for informado. MIME TYPE do arquivo: |
filaEspera | M | Objeto | Objeto com dados da fila de espera |
|
tempoEspera | M | Objeto | Objeto com dados do tempo de espera. |
|
{
"titulo":"String",
"subtitulo":"String",
"descricao":"String",
"filaEspera":{ Objeto },
"tempoEspera":{ Objeto }
}
Objeto filaEspera
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
titulo | M | String | Chave de identificação do paciente |
|
descricao | M | String | Número do contrato do paciente |
|
valor | M | String | Nome do paciente |
|
Objeto tempoEspera
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
titulo | M | String | Chave de identificação do paciente |
|
descricao | M | String | Número do contrato do paciente |
|
valor | M | String | Nome do paciente |
|
Exemplo retorno API - sucesso
Descrição dos objetos e atributos de retorno - falha
Objetos e atributos de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
mensagem | M | String | mensagem para ser exibida para o cliente | texto livre |
Exemplo retorno API - falha
Mobile Saúde - Mosia Omnichannel