Tipos e métodos de autenticação
Os aplicativos podem ter um número ilimitado de autenticações. Em cada solicitação, uma autenticação específica é selecionada, e tal solicitação será feita exatamente com o token de acesso que essa autorização recebeu.
Ainda na própria autenticação, na última etapa, é configurado o “template” da solicitação API com os dados de autenticação, de forma que, ao configurar posteriormente o aplicativo, não é preciso ajustar cada widget de solicitação. Por exemplo, se o Access token é sempre passado em um cabeçalho específico, na etapa 4 você precisará criar esse cabeçalho e colocar no valor o Access token.
A autenticação pode ser de:
Tipo - o tipo de dado transmitido ao sistema é configurado;
Método - seleciona-se o método e modelo de autenticação do aplicativo.
Existem três tipos de autenticação:
Personalizado - a autenticação não possui um conjunto de campos pré-configurados, portanto, criam-se todos os campos necessários, os quais serão solicitados ao próprio usuário final e transferidos para o sistema. É possível fazer uma solicitação adicional de API para troca de alguns dados de um token de acesso Access token, se necessário, com atualização via token Refresh Refresh token.
Por login e senha - o login e a senha serão passados para o sistema. Eles podem ser transmitidos na forma pura ou codificados no formato base64 (Basic auth).
Por token - um Access token será enviado ao sistema. É possível fazer uma solicitação adicional de API para troca de alguns dados de um Access token, se necessário, com atualização via Refresh token.
Os métodos de autenticação dependem do tipo selecionado. Os seguintes métodos de autenticação estão disponíveis:
Manual - ao criar uma conexão, os campos são exibidos, dependendo do tipo. Os dados salvos pelo usuário final são registrados como parte da conexão, e nenhuma solicitação de API adicional é feita no momento da criação da conexão.
Por chave API - ao criar uma conexão, uma chave API é solicitada ao usuário final. Em seguida, o método API é configurado por meio do widget de solicitação para trocar a chave API por um token de acesso, com a capacidade de atualizar por meio do Refresh token.
Por login e senha - ao criar uma conexão, é solicitado ao usuário final a inserção de um login e uma senha. Este login e senha são trocados por meio de solicitações de API por token de acesso, com possibilidade de atualização por meio de Refresh token.
oAuth - autenticação pelo protocolo OAuth. O usuário final fornece acesso ao serviço por meio de autenticação no próprio serviço com a janela aberta e permissões de acesso.
Em cada autenticação, é obrigatório selecionar o tipo e o método. Existem várias combinações possíveis dessas opções.
Se o tipo for “**Personalizado**”, os seguintes métodos estão disponíveis:
Manual
Por chave API
Por login e senha
Se o tipo for “**Por login e senha**”, é disponível somente o método “Manual”.
Se o tipo “**Por token**” for selecionado, os seguintes métodos estarão disponíveis:
Manual
Por chave API
Por login e senha
oAuth
Ainda na própria autenticação, na última etapa, é configurado o “template” da solicitação API com os dados de autenticação, de forma que, ao configurar posteriormente o aplicativo, não é preciso ajustar cada widget de solicitação. Por exemplo, se o Access token é sempre passado em um cabeçalho específico, na etapa 4 você precisará criar esse cabeçalho e colocar no valor o Access token.
A autenticação pode ser de:
Tipo - o tipo de dado transmitido ao sistema é configurado;
Método - seleciona-se o método e modelo de autenticação do aplicativo.
Tipos de autenticação
Existem três tipos de autenticação:
Personalizado - a autenticação não possui um conjunto de campos pré-configurados, portanto, criam-se todos os campos necessários, os quais serão solicitados ao próprio usuário final e transferidos para o sistema. É possível fazer uma solicitação adicional de API para troca de alguns dados de um token de acesso Access token, se necessário, com atualização via token Refresh Refresh token.
Por login e senha - o login e a senha serão passados para o sistema. Eles podem ser transmitidos na forma pura ou codificados no formato base64 (Basic auth).
Por token - um Access token será enviado ao sistema. É possível fazer uma solicitação adicional de API para troca de alguns dados de um Access token, se necessário, com atualização via Refresh token.
Métodos de autenticação
Os métodos de autenticação dependem do tipo selecionado. Os seguintes métodos de autenticação estão disponíveis:
Manual - ao criar uma conexão, os campos são exibidos, dependendo do tipo. Os dados salvos pelo usuário final são registrados como parte da conexão, e nenhuma solicitação de API adicional é feita no momento da criação da conexão.
Por chave API - ao criar uma conexão, uma chave API é solicitada ao usuário final. Em seguida, o método API é configurado por meio do widget de solicitação para trocar a chave API por um token de acesso, com a capacidade de atualizar por meio do Refresh token.
Por login e senha - ao criar uma conexão, é solicitado ao usuário final a inserção de um login e uma senha. Este login e senha são trocados por meio de solicitações de API por token de acesso, com possibilidade de atualização por meio de Refresh token.
oAuth - autenticação pelo protocolo OAuth. O usuário final fornece acesso ao serviço por meio de autenticação no próprio serviço com a janela aberta e permissões de acesso.
Possível relação entre tipo e método
Em cada autenticação, é obrigatório selecionar o tipo e o método. Existem várias combinações possíveis dessas opções.
Se o tipo for “**Personalizado**”, os seguintes métodos estão disponíveis:
Manual
Por chave API
Por login e senha
Se o tipo for “**Por login e senha**”, é disponível somente o método “Manual”.
Se o tipo “**Por token**” for selecionado, os seguintes métodos estarão disponíveis:
Manual
Por chave API
Por login e senha
oAuth
Atualizado em: 01/12/2022
Obrigado!