Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Índice
Dica

Só são suportadas integrações no padrão REST.

...

Aviso

Tokens de segurança ou autenticação

A Mobile Saúde descreve nesta documentação o formato de adoção obrigatória quando sua empresa desejar utilizar TOKENS de segurança.

O formato suportado pela aplicação está descrito no objeto SEGURANÇA, e sua empresa deve necessariamente implementa-lo conforme descrito quando desejar utilizar essa camada adicional de segurança.

Não serão suportadas outras formas de transacionar TOKENs de segurança, como por exemplo tokens de autenticação na URL da requisição, entre outros.

Caso tenha dúvidas, ou deseje maiores esclarecimentos, entre em contato com o gestor de projeto encarregado de sua implantação, para atendimento às questões ANTES DE DESENVOLVER SUA API.

 

Objeto permissões

Devemos somente informar na estrutura de permissões dentro do objeto contratos as funcionalidades que o usuário não tem acesso ou ocultar caso queira que não apareça, mas para requisito de validação da estrutura do beneficiário, eleger uma ou mais funcionalidades junto com a equipe de desenvolvimento da Mobile Saúde para facilitar os testes de permissionamento.

Lembrando que a tabela de funcionalidades está no final do documento de especificações.

 

Exemplos de uso:

  • Funcionalidade negada com mensagem customizada

 "permissoes": [ {

        "funcionalidade": "1",

        "acesso": false,

        "mensagemBloqueio": "Você não possui acesso a está funcionalidade, para mais informações entre em contato com 0800",

        "ocultar": false

}]

  • Funcionalidade negada sem mensagem customizada, será exibida uma mensagem padrão

 "permissoes": [ {

        "funcionalidade": "1",

        "acesso": false,

        "mensagemBloqueio": null,

        "ocultar": false

}]

  • Funcionalidade oculta no app

"permissoes": [ {

        "funcionalidade": "1",

        "acesso": false,

        "mensagemBloqueio": null,

        "ocultar": true

}]

  • Acesso liberado

"permissoes": null

Dica

Retornar ao índice

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

Nota

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 "usuarioLogado":

  • usuario-logado

  • usuario_logado

  • usuario

  • usuarioLogado (concordo)

Método - Relogin

Dica

Endpoint

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ relogin

Nota

Atenção

O endpoint obrigatoriamente deve terminar com "/relogin".

POST

application/json

Endpoint de relogin

...