Esta postagem do blog ensinará sobre os conectores do Okta Workflows:
- Use um conector pré-criado
- Usar o Conector de API pré-construído
- Use um conector criado com o Connector Builder
- Qual opção de conector usar
- Recursos do Okta Workflows
Use um conector pré-criado
Ao começar a construir com Okta Workflows, use um dos mais de 60 conectores pré-construídos. Conectores pré-construídos controlam aplicativos ou serviços web como Okta, Gmail, Office 365, Slack, Jira e outros.
Conectores do Okta Workflows.
Cada conector tem ações.
A seguir, uma lista parcial de ações disponíveis no conector Okta:
Ações do conector Okta.
Essas ações estão disponíveis no conector Google Drive:
Lista parcial de ações do conector do Google Drive.
As ações do Okta Workflows são endpoints de API nos bastidores.
Configurar uma conexão
Você deve criar uma conexão para autenticar com esse aplicativo ou serviço antes de chamar as ações. O método de autenticação depende do conector. Os tipos de autenticação incluem chaves de API, autenticação básica, OAuth ou personalizado.
Você pode criar e salvar várias conexões para um conector. Uma conexão pode ser para um ambiente de teste e outra para o ambiente de produção.
A página Conexões lista as conexões que você configurou:
Conexões do Okta Workflows (lista parcial).
Chamar uma ação
Adicione um card de aplicativo de ação em um fluxo para chamar uma ação de um conector.
Por exemplo, a imagem a seguir mostra a chamada da ação Read User do conector Okta.
A ação Okta – Read User.
Nos bastidores, a ação chama a Get User Okta API ao testar o fluxo:
Executando um fluxo com o card Okta – Read User.
Uma ação expõe campos de entrada correspondentes aos parâmetros de solicitação da API e campos de saída correspondentes à resposta da solicitação da API.
Usar as ações do conector é mais simples do que configurar uma chamada de API manual. Você configura uma conexão, e o card solicita que você insira as entradas necessárias para executar a ação.
Chamar uma ação personalizada
O Okta Workflows tem um conector Shopify pré-construído. O conector Shopify tem as seguintes ações:
Ações do conector Shopify.
A imagem abaixo mostra o uso da ação Shopify – Create Customer do conector:
Shopify – Ação Create Customer.
Digamos que você queira listar todos os clientes no Shopify.
Você não verá uma ação de Listar Todos os Clientes se observar a lista de ações. Mas você verá o endpoint da API recupera uma lista de clientes na documentação do desenvolvedor da Shopify.
Como você chama este endpoint de um fluxo do Okta Workflows?
Cada conector tem a ação Custom API Action que permite chamar qualquer endpoint da API no conector.
Ação Custom API Action.
A captura de tela abaixo mostra o cartão Custom API Action do Shopify. O cartão reutiliza as informações de conexão do Shopify e permite inserir o URL relativo da API, consulta e parâmetros de cabeçalhos.
Cartão Custom API Action.
Use a Ação de API Personalizada nos seguintes casos de uso:
- Você precisa chamar um endpoint de API que não está disponível no conector pré-construído.
- Uma ação está disponível no conector pré-construído, mas não expõe todos os parâmetros de solicitação.
A captura de tela abaixo mostra o uso do cartão Custom API Action para listar todos os clientes no Shopify:
O card Shopify Custom API Action.
Você pode definir os campos Query e Headers se a API exigir.
Testando o fluxo com o card Custom API Action lista todos os clientes da Shopify:
Testando o card Shopify Custom API Action.
Até agora, você aprendeu sobre os conectores pré-construídos. Você pode usar as ações disponíveis ou as ações de API personalizadas.
Na seção a seguir, você aprenderá como chamar uma API que não tem um conector pré-criado no Okta Workflows.
Usar o Conector de API pré-construído
Você deseja usar ShipEngine API para validar endereços. O ShipEngine não tem um conector pré-construído no Okta Workflows. Você pode usar o conector API Connector para chamar a API do ShipEngine ou qualquer outra API que não tenha um conector pré-construído no Okta Workflows.
Selecionando o Conector de API.
Na captura de tela abaixo, você verá os métodos HTTP quando selecionar a opção API Connector:
Ações do API Connector.
A API Validate an Address do ShipEngine usa um POST. Escolha a ação Post:
O cartão API Connector – Post.
Você deve fornecer os campos URL, Query, Headers e Body para a solicitação de API. Você também precisa configurar a autenticação para a solicitação.
Validar endereço com a API ShipEngine.
Para configurar o card API Connector – Post:
- Defina o campo **URL** como **https://api.shipengine.com/v1/addresses/validate**.
- O serviço ShipEngine usa uma chave de API para autenticação. O card Compose cria a string de chave de API e a passa para o campo Headers.
- O card Compose cria o endereço para validar e o passa para o campo Body.
Executando o flow para validar um endereço:
Validar endereço com execução do fluxo ShipEngine API.
Reutilizar informações de conexão
Se você usa uma API com frequência, pode mover as informações de autenticação para uma conexão e reutilizá-la.
Conexão ShipEngine.
Com a autenticação da API salva em uma conexão, você pode reutilizar a conexão ao chamar a API ShipEngine:
Chamando a API ShipEngine.
Você aprendeu como chamar uma API usando o API Connector pré-construído. A seção a seguir ensinará como construir um conector com a ferramenta Connector Builder.
Use um conector criado com o Connector Builder
Se você quiser que sua API tenha um conector pré-criado, você deve usar o Okta Workflows Connector Builder para construir um conector para a API. Você verá o conector listado quando adicionar uma ação de aplicativo.
Conectores do Okta Workflows.
O Connector Builder é uma ferramenta de desenvolvimento sem código para criar conectores na plataforma Okta Workflows. O Connector Builder usa Okta Workflows (fluxos, cartões de ação e função) para criar um conector.
Inicie o Connector Builder.
Você gosta da API ShipEngine. Você quer que um builder do Okta Workflows abra a lista de conectores e veja um ícone e um conector para ShipEngine. Para ver um conector para a API ShipEngine, você cria o conector no Connector Builder.
O Connector Builder tem várias visualizações.
A aba Overview tem informações gerais sobre o conector.
Visão geral do conector.
A guia Flows lista os fluxos que compõem o conector.
- O fluxo httpHelper gerencia a autenticação.
- O fluxo _authping verifica a saúde da conexão.
- O fluxo Validate cria a ação Validate do conector.
- O fluxo Custom API Action cria a ação Custom API Action do conector.
Fluxos do conector.
O fluxo a seguir mostra a implementação da ação Validate:
Ação Validate do conector.
A aba Test Connections contém informações de conexão para testar o conector.
A aba Implantação permite implantar o conector. Existem duas opções de implantação.
- Implantação privada – o conector está disponível somente na sua organização Okta.
- Implantação pública – o conector está disponível para todas as organizações e todos os criadores do Okta Workflows. Você deve submeter o conector para a Okta para revisão para implantação pública.
Implantação do conector.
Você pode selecionar o conector (PostOffice) da lista de conectores:
Conector listado na lista de conectores.
Use a ação Post Office – Validate para validar um endereço:
Valide um endereço com o conector PostOffice.
Executando o fluxo:
Validando um endereço.
Qual opção de conector usar
Você aprendeu sobre três maneiras de chamar APIs no Okta Workflows:
- Use os conectores pré-construídos.
- Quando um conector não oferece suporte a um endpoint de API específico, use a ação custom API para chamar qualquer API no conector.
- Use o card API Connector.
- Mova as informações de autenticação para uma conexão para reutilizar.
- Use o Connector Builder para construir um conector para uma API.
Use os conectores pré-construídos e o card API Connector com mais frequência. Os conectores pré-construídos e o card API Connector oferecem uma solução leve para chamadas de API para serviços.
Use o Connector Builder para criar uma experiência de conector pré-construída para o construtor de automação. Um conector pré-construído ajuda os membros da equipe que não estão familiarizados com o trabalho com APIs.
Leia When to Use Connector Builder and when to Use the API Connector para saber mais.
Recursos do Okta Workflows
📖 Documentação do Connector Builder.
📺 Building a Custom Connector in Okta Workflows, a Video Series.
🍫 Obtenha ajuda de especialistas do Workflows durante o plantão semanal da comunidade.
🛟 Obtenha ajuda do suporte: discuta um tópico do Workflows ou faça uma pergunta.
🙋🏻♀️ Obtenha ajuda da comunidade: participe do canal #okta-workflows no MacAdmins Slack.
