Ir para o conteúdo

Conexão GraphQL v2

Introdução

Uma conexão GraphQL, criada usando o conector GraphQL v2, estabelece acesso ao GraphQL. Essas atividades, uma vez configuradas, interagem com o GraphQL por meio da conexão.

Crie ou edite uma conexão GraphQL

Uma nova conexão GraphQL v2 é criada usando o conector GraphQL v2 de um destes locais:

Uma conexão GraphQL v2 existente pode ser editada nestes locais:

Configurar uma conexão GraphQL

Cada elemento da interface do usuário da tela de configuração de conexão do GraphQL v2 é descrito abaixo.

Dica

Campos com um ícone variável suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir uma lista das variáveis existentes para escolher.

  • Nome da conexão: Insira um nome para usar para identificar a conexão. O nome deve ser exclusivo para cada conexão GraphQL v2 e não deve conter barras (/) ou dois pontos (:). Este nome também é usado para identificar o endpoint do GraphQL v2, que se refere a uma conexão específica e suas atividades.

  • URL: Insira a URL.

  • Esquema de autorização: Selecione o esquema de autorização, um dos seguintes:

    • Nenhum

    • Básico

      • Usuário: Digite o usuário.

      • Senha: Digite a senha.

    • OAuth

      • URL de retorno de chamada: Insira a URL de retorno de chamada.

      • URL de autorização do OAuth: Insira a URL de autorização do OAuth.

      • URL do token de acesso OAuth: Insira a URL do token de acesso OAuth.

      • URL do token de atualização do OAuth: Insira a URL do token de atualização do OAuth.

      • Iniciar OAuth: Selecione a configuração OAuth, uma das seguintes:

        • DESLIGADO

          • Token de acesso OAuth: Insira o token de acesso OAuth.

        • OBTENHAEATUALIZE

        • ATUALIZAR

          • Token de acesso OAuth: Insira o token de acesso OAuth.

      • Versão do OAuth: Selecione a versão do OAuth, uma das seguintes:

        • Desativado

        • 1,0

        • 2.0

      • ID do cliente OAuth: Insira o ID do cliente OAuth.

      • Segredo do cliente OAuth: Insira o segredo do cliente OAuth.

      • URL do token de solicitação OAuth: Insira a URL do token de solicitação OAuth.

      • Token de atualização do OAuth: Insira o token de atualização do OAuth.

    • OAuthPKCE

      • URL de retorno de chamada: Insira a URL de retorno de chamada.

      • URL de autorização OAuth: Insira a URL de autorização OAuth.

      • URL do token de acesso OAuth: Insira a URL do token de acesso OAuth.

      • URL do token de atualização do OAuth: Insira a URL do token de atualização do OAuth.

      • Iniciar OAuth: Selecione a configuração OAuth, uma das seguintes:

        • DESLIGADO

          • Token de acesso OAuth: Insira o token de acesso OAuth.

        • OBTENHAEATUALIZE

        • ATUALIZAR

          • Token de acesso OAuth: Insira o token de acesso OAuth.

      • ID do cliente OAuth: Insira o ID do cliente OAuth.

      • Token de atualização do OAuth: Insira o token de atualização do OAuth.

    • AwsCognitoSrp

      • Usuário: Digite o usuário.

      • Região do AWS Cognito: Selecione a região do AWS Cognito, uma das seguintes:

        • OHIO

        • NORTE DA VIRGÍNIA

        • CALIFÓRNIA DO NORTE

        • OREGÔNIA

        • CIDADE DO CABO

        • HONG KONG

        • HYDERABAD

        • JACARTA

        • MELBOURNE

        • MUMBAI

        • OSAKA

        • SEUL

        • SINGAPURA

        • SÍDNEY

        • TÓQUIO

        • CENTRAL

        • CALGARY

        • PEQUIM

        • NINGXIA

        • FRANKFURT

        • IRLANDA

        • LONDRES

        • MILÃO

        • PARIS

        • ESPANHA

        • ESTOCOLMO

        • ZURIQUE

        • TELAVIV

        • BAHREIN

        • Emirados Árabes Unidos

        • SAOPAULO

        • GOVCLOUDEAST

        • GOVCLOUDWEST

        • USO ISOLADO LESTE

        • USO ISOLADO AST B

        • ISOLADO OESTE DOS EUA

      • ID do pool de usuários da AWS: Insira o ID do pool de usuários da AWS.

      • ID do aplicativo cliente do pool de usuários da AWS: Insira o ID do aplicativo cliente do pool de usuários da AWS.

      • Segredo do aplicativo cliente do pool de usuários da AWS: Insira o segredo do aplicativo cliente do pool de usuários da AWS.

    • AwsCognitoBásico

      • Usuário: Digite o usuário.

      • Senha: Digite a senha.

      • Região do AWS Cognito: Selecione a região do AWS Cognito, uma das seguintes:

        • OHIO

        • NORTE DA VIRGÍNIA

        • CALIFÓRNIA DO NORTE

        • OREGÔNIA

        • CIDADE DO CABO

        • HONG KONG

        • HYDERABAD

        • JACARTA

        • MELBOURNE

        • MUMBAI

        • OSAKA

        • SEUL

        • SINGAPURA

        • SÍDNEY

        • TÓQUIO

        • CENTRAL

        • CALGARY

        • PEQUIM

        • NINGXIA

        • FRANKFURT

        • IRLANDA

        • LONDRES

        • MILÃO

        • PARIS

        • ESPANHA

        • ESTOCOLMO

        • ZURIQUE

        • TELAVIV

        • BAHREIN

        • Emirados Árabes Unidos

        • SAOPAULO

        • GOVCLOUDEAST

        • GOVCLOUDWEST

        • USO ISOLADO LESTE

        • USO ISOLADO AST B

        • ISOLADO OESTE DOS EUA

      • ID do pool de usuários da AWS: Insira o ID do pool de usuários da AWS.

      • ID do aplicativo cliente do pool de usuários da AWS: Insira o ID do aplicativo cliente do pool de usuários da AWS.

      • Segredo do aplicativo cliente do pool de usuários da AWS: Insira o segredo do aplicativo cliente do pool de usuários da AWS.

  • Usar configurações de proxy: Selecione para usar configurações de proxy do agente privado.

  • Configurações avançadas: Quando selecionado, mostra a tabela Propriedades de configurações avançadas, que é usada para adicionar propriedades de configuração adicionais como pares chave-valor.

    • Add: Adiciona uma linha à tabela. Insira um par chave-valor para cada propriedade.
    • Enviar: Salva o par chave-valor na tabela. Visível ao passar o mouse sobre uma linha no modo de edição.
    • Descartar: Descarta uma nova linha ou quaisquer edições feitas em uma linha existente. Visível ao passar o mouse sobre uma linha no modo de edição.
    • Editar: Permite que você edite um par chave-valor existente. Visível ao passar o mouse sobre uma linha existente.
    • Excluir: Exclui a linha da tabela. Visível ao passar o mouse sobre uma linha existente.
    • Limpar tudo: Exclui todas as linhas da tabela.

    Importante

    Os campos na tabela Configurações avançadas exibem o ícone da variável somente no modo de edição. Para que os valores variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

  • Teste: Clique para verificar a conexão usando a configuração especificada. Quando a conexão é testada, a versão mais recente do conector é baixada pelo(s) agente(s) no grupo de agentes associado ao ambiente atual. Este conector suporta a suspensão do download da versão mais recente do conector usando a Desabilitar atualização automática do conector política da organização.

  • Salvar alterações: Clique para salvar e fechar a configuração de conexão.

  • Descartar alterações: Após fazer alterações em uma configuração nova ou existente, clique para fechar a configuração sem salvar. Uma mensagem pede para você confirmar que deseja descartar as alterações.

  • Excluir: Após abrir uma configuração de conexão existente, clique para excluir permanentemente a conexão do projeto e fechar a configuração (consulte Dependências, exclusão e remoção de componentes). Uma mensagem pede para você confirmar que deseja excluir a conexão.

Configurar conexões OAuth

Este conector suporta uma conexão usando OAuth usando propriedades de configuração específicas. Após selecionar um esquema de autenticação que inclui Initiate OAuth, você poderá especificar a configuração nos campos que são exibidos.

Nota

IDs, segredos, escopos e outros tokens de autenticação adicionais podem ser necessários para concluir com sucesso a autenticação OAuth. Verifique a documentação do endpoint para obter informações adicionais sobre seus requisitos.

Para este conector, dois cenários são suportados. Em qualquer cenário, você precisará usar uma ferramenta de externo (como Postman ou uma ferramenta similar) para obter o token ou tokens de acesso necessários do endpoint envolvido. Ambos os cenários funcionam apenas para grupos de agente único. Estes são grupos de agentes que consistem em um único agente.

  • Cenário 1: Usando um token de acesso OAuth que expira após um período de tempo definido.

    Com essa configuração, você fornece um token de acesso OAuth que dura por um período de tempo definido, conforme determinado pelo endpoint específico. O conector usará o token para fazer a conexão. A conexão, no entanto, não funcionará mais quando o token de acesso expirar. Você configuraria o conector para usar o token definindo estas propriedades:

    Propriedade de configuração Valor
    Iniciar OAuth OFF
    Token de acesso OAuth Definido como o valor do token de acesso OAuth obtido do endpoint

  • Cenário 2: Usar um token de acesso OAuth combinado com um token de atualização OAuth para habilitar a atualização automática de acesso.

    Com essa configuração, o conector usará um token de atualização para obter um novo token de acesso quando o token de acesso atual tiver expirado. Esse é geralmente o melhor método de configuração do OAuth.

    Você fornece um token de acesso OAuth e um token de atualização OAuth, conforme determinado pelo endpoint específico. Você configuraria o conector para usar esses tokens definindo estas propriedades:

    Propriedade de configuração Valor
    Iniciar OAuth REFRESH
    Token de acesso OAuth Definido como o valor do token de acesso OAuth obtido do endpoint
    Token de atualização OAuth Definido como o valor do token de atualização OAuth obtido do endpoint

Nota

Se estiver usando várias conexões GraphQL v2 baseadas em OAuth no mesmo agente privado, defina a propriedade de configuração OAuthSettingsLocation para um caminho de agente gravável exclusivo para cada conexão. No jitterbit.conf arquivo para o agente, defina EnableLocalFileLocation=true. Se você não executar essas duas etapas, as múltiplas conexões usarão o mesmo caminho padrão e substituirão umas às outras.

Próximos passos

Após a criação de uma conexão de conector GraphQL, você coloca um tipo de atividade na quadro de design para criar instâncias de atividade a serem usadas como fontes (para fornecer dados em uma operação) ou como destinos (para consumir dados em uma operação).

As ações de menu para uma conexão e seus tipos de atividade são acessíveis a partir do painel do projeto e da paleta de componentes de design. Para obter detalhes, consulte Menus de ações em Noções básicas do conector.

Esses tipos de atividade estão disponíveis:

  • Consulta: Recupera registros de uma tabela no GraphQL e deve ser usado como fonte em uma operação.

  • Executar: Executa um procedimento no GraphQL e deve ser usado como um alvo em uma operação.