Key (Chave Única de Acesso)

Este método disponibiliza uma tela padrão para que o usuário informe uma chave de credenciamento fornecida pelo cliente proprietário do app. Quando o usuário enviar a chave, o app irá acionar a requisição de credenciamento do cliente, informada no mapeamento de integrações.

1. Configure o método de credenciamento do Endpoint

{   …, 
    "authType": "Key",
    "authPath": "LOGIN”
 }

1. Crie um mapeamento de segurança do tipo “UserSecurity” dentro do endpoint

[
  {
    "identifier": "LOGIN",
    "serviceConfiguration": {
      "protocol": "https",
      "url": "api.cliente.br/Login",
      "method": "POST",
      "header": {
        "KEY": "[[USERNAME]]",
         ...
      },
      "content-type": 
      "x-www-form-urlencoded"
    }
  },
  {
  //Mapping adicional caso a integração possua refresh token.
    "identifier": "REFRESHTOKEN",
    "serviceConfiguration": {
      "protocol": "https",
      "url": "api.cliente.br/Login",
      "method": "POST",
      "header": {
         ...
      },
      "body": {
        - campos do formulário - 
        "refresh_token": "[[REFRESHTOKEN]]"
      },
      "content-type": 
      "x-www-form-urlencoded"
    }
  }
]

Retorno do serviço de integração:

Statuscode: 200 ou 202 ou 206

{
    "access_token": "TbeMM-iwSQEHQfKEHfpX...",
    "refresh_token": "AFeMM-iwSQEHQfKEHHJH...",
    "userId": "83e1c3df-fe12-41fc-a4ce-e37d6732cef3",
    "message": "Seu credenciamento foi realizado com sucesso",
    "actions":[..]	
}

Tela apresentada