Grupo de Autorização de Integração

- 1.1 Contexto
- 1.2 Com funciona
- 1.3 Parâmetros de entrada
- 1.4 Endpoint
- 1.5 Exemplo request
- 1.6 Descrição dos objetos e atributos de retorno - Sucesso
- 1.7 Exemplo retorno API - sucesso
- 1.8 Descrição dos objetos e atributos de retorno - falha
- 1.9 Objetos e atributos de retorno
- 1.10 Exemplo retorno API - falha
2 Request na plataforma
3 Utilização no request - Login
4 Utilização no request - Formbuilder

Contexto

Grupos de Autorização é um cadastro a parte da configuração de integração, tem um próprio formulário de cadastro na área de segurança, e também tem sua estrutura validada antes de ser cadastrado.

Sua ligação com a configuração de integração, é que ela pode ser selecionada como uma opção de segurança para integração.

Ou seja antes de realizar algum request para a sua API é possível revesti-la com uma camada de segurança que permitirá que sua aplicação torne-se mais blindada a situações de acessos indesejados.

Com funciona

O valor guardado de chave e valor da API de grupo de autorização ficam cacheados e são atualizados dinamicamente.

Caso implementado, este método é obrigatório;
Atente-se as orientações fornecidas pela Mobile Saúde;
Atente-se as orientações de segurança e permissões;
Atente-se aos critérios de preenchimento;
Atente-se aos critérios de objetos e atributos de retorno;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Parâmetros de entrada

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
usuario	M	String	usuário a ser passado no request
senha	M	String	Senha a ser passada no request.

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
exemplo.com autorizacao Atenção O endpoint obrigatoriamente deve terminar com "/autorizacao".	POST	application/json	Endpoint de autorizacao

Exemplo request

curl --location --request POST 'https://demo8374353.mockable.io/autorizacao' \
--header 'Content-Type: application/json' \
--data-raw '{
    "usuario":"62591304220",
    "senha":"123456"
}'

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.

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
auth	M	Objeto auth	Lista parâmetros que devem ser enviados no retorno do webservice	Preencher com o objeto do tipo "auth".
token	M	String	Token de retorno do webservice
chave	M	String	Chave de retorno do webservice	A chave Authorization não pode ser utilizada, pois é reservada às requisições do Mosia Omnichannel

Exemplo retorno API - sucesso

{
 "auth": [
     {
      "token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
      "chave" : "meutoken" 
     }]
}

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

Objetos e atributos de retorno

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

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

{
   "status: 400
   "mensagem": "Usuário/senha não encontrados",
}

Request na plataforma

Aba "seguranças";
Selecione “Grupo de autorização de integração”
Preencha os campos de"
- “URL Webservice”, “Usuário”, “Senha” e em seguida validar a integração em “Validar Integração;