Configuração da autenticação

Um dos grandes colunas para criar um conector é identificar e integrar corretamente sua configuração de autenticação. Se feito corretamente, assim que o conector for publicado no catálogo do Integration Service, os usuários poderão criar conexões com ele assim como fazem com qualquer outro conector dentro do catálogo.

Todos os conectores reutilizam a estrutura de autenticação para que o fluxo completo de autenticação e o gerenciamento de conexões possam ser processados em uma abordagem unificada.

O resultado final da autenticação é que qualquer solicitação subsequente dentro desse conector usa o resultado do processo de autenticação para cada chamada de API. Por exemplo, um token do portador é enviado nos cabeçalhos em cada chamada de API:

O Connector Builder é compatível com os seguintes padrões do setor por meio de configuração simples, em vez de codificação extensiva:

Código de autorização do OAuth 2.0
Código de autorização do OAuth 2.0 com PKCE
Credenciais do cliente OAuth 2.0
Básica
Chave de API
Token de acesso pessoal (PAT)
Personalizado
Sem autenticação

Como o Construtor de Conector está vinculado à estrutura do Integration Service, definir sua configuração de autenticação agora é uma questão de configuração, e não um processo complexo. Isso significa que o framework lida com trocas de tokens, atualizações e quaisquer outras tarefas desse tipo. O padrão do Construtor de Conector é usar o código de autorização do OAuth 2.0, já que essa é a abordagem mais comum do fornecedor para lidar com a autenticação.

A página de autenticação é feita de três componentes:

O Tipo de autenticação, que orienta como a estrutura de autenticação reflete com validação adicional para PKCE, troca completa de tokens (para OAuth) etc. Além disso, ele também reconfigura a tabela com propriedades por baixo, para que as propriedades necessárias fiquem delineadas.
A tabela de propriedades pode ser modificada com parâmetros personalizados e/ou editando os existentes. Dependendo da seleção do Tipo de autenticação no menu suspenso, alguns campos podem ser obrigatórios e especificados em vermelho.
Observação: alterar essas propriedades dentro desta tabela ou do tipo de autenticação em geral invalida a conexão que você já pode ter criado no Connector Builder. Há apenas uma conexão durante o tempo de design e ela precisa ser configurada e testada em relação à configuração de autenticação mais recente.
A tela Autenticação é gerada automaticamente com base na configuração que você forneceu. O que você vê durante a configuração no Connector Builder é exatamente o resultado final que os usuários do seu pacote de atividades verão.

Configuração da tabela de autenticação

Independentemente do tipo de autenticação, a tabela de propriedades carregada identifica dois itens:

O que o usuário vê na tela de autenticação.
Como a autenticação é tratada pela estrutura de autenticação.

Cada item de linha na tabela representa uma propriedade que pode ou não ser substituída pelo usuário. Para apresentar um determinado campo na tela, ele precisa ser sinalizado como Perguntar ao usuário — Sim.
Cada item de linha tem um Nome e um Nome de exibição. O Nome é o que o fornecedor espera para a configuração técnica, e este é de grande importância em como solicitar essa entrada do usuário na tela de autenticação.
Cada item de linha tem um menu de ação que permite editar a propriedade com muito mais detalhes. É aqui que você pode indicar que uma determinada propriedade precisa ser enviada como um cabeçalho. Veja mais exemplos na seção Chave de API .

Tipos de autenticação

Na guia Autenticação , você configura o tipo de autenticação para o seu conector. As opções suportadas são:

Código de autorização do OAuth 2.0
Código de autorização do OAuth 2.0 com PKCE
Credenciais do cliente OAuth 2.0
Básica
Chave de API
Token de acesso pessoal (PAT)
Personalizado
Sem autenticação

Observação: ao configurar a autenticação, você está configurando como qualquer pessoa usando seu conector precisa se autenticar. Este será você enquanto estiver criando o conector, mas também podem ser outras pessoas que acabarão usando sua criação.

Autenticação básica

Selecione Editar na coluna Ação para configurar cada propriedade. Nome de Usuário e Senha estão disponíveis por padrão.
Selecione Adicionar parâmetro se quiser adicionar outro campo para ser usado durante a autenticação:
- Nome da exibição - Exibido para o usuário ao se conectar.
- Tipo — define o campo de entrada na caixa de diálogo de conexão. Selecione uma opção no menu suspenso: verdadeiro/falso, senha, teste, sim/não.
- Perguntar ao usuário — Defina como Sim quando for necessária a entrada do usuário.
- Valor — Use esse campo para definir um valor padrão.
- Texto da dica – Orientações para o usuário no campo de entrada.
- Nome do provedor - A chave técnica para a chamada de API.
- Enviar para o provedor como tipo – Como a API recebe o valor. Selecione uma opção no menu suspenso: configuração, cabeçalho, caminho, corpo, consulta e formulário. Valor padrão: header.
Selecionar Salvar para salvar seu novo parâmetro de autenticação.
Use a opção Redefinir para o padrão se quiser redefinir sua autenticação para os valores originais para Básico. Esta operação não pode ser desfeita.

Código de autorização do OAuth 2.0

Para usar o Código de autorização do OAuth 2.0, você precisa criar um aplicativo OAuth no aplicativo com o qual deseja se integrar e recuperar de lá as credenciais necessárias para configurar seu conector.

Configure os campos a seguir:

ID do Cliente
Segredo do cliente
Escopo
URL de autorização
URL do token
URL de atualização do token
Cabeçalho básico
URL de revogação do token
Intervalo de atualização

Observação: os URLs de autorização, token e token de atualização devem estar disponíveis na documentação da API do aplicativo.

Código de autorização do OAuth 2.0 com o PKCE

O código de autorização do OAuth 2.0 com PKCE é idêntico ao método do código de autorização do OAuth 2.0, mas também inclui o campo método de desafio do código PKCE do OAuth2 .