Conexão GraphQL

Introdução

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

Criar ou editar uma conexão GraphQL

Uma nova conexão GraphQL é criada usando o conector GraphQL a partir de uma destas localizações:

• A aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).
• A página Endpoints Globais (veja Criar um endpoint global em Endpoints Globais).

Uma conexão GraphQL existente pode ser editada a partir destas localizações:

• A aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).
• A aba Componentes do painel do projeto (veja Menu de ações de componentes em Aba de Componentes do painel do projeto).
• A página Endpoints Globais (veja Editar um endpoint global em Endpoints Globais).

Configurar uma conexão GraphQL

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

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

• Autenticação: Quando selecionado (padrão), mostra configurações adicionais. Para documentação, veja Estabelecendo uma conexão e Propriedades de configurações adicionais:

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

    • Nenhum

    • Básico

    • OAuth

    • AwsCognitoSrp

    • AwsCognitoBasic

  • URL: Insira a URL.

  • Usuário: Insira o usuário.

  • Senha: Insira a senha.

• Autenticação AWS: Quando selecionado, mostra configurações adicionais. Para documentação, veja Estabelecendo uma conexão e Propriedades de configurações adicionais:

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

    • OHIO

    • VIRGINIANORTE

    • CALIFÓRNIANORTE

    • OREGON

    • CAPETOWN

    • HONGKONG

    • MUMBAI

    • OSAKA

    • SEOUL

    • SINGAPORE

    • SYDNEY

    • TOKYO

    • CENTRAL

    • BEIJING

    • NINGXIA

    • FRANKFURT

    • IRELAND

    • LONDON

    • MILAN

    • PARIS

    • STOCKHOLM

    • BAHRAIN

    • SAOPAULO

    • GOVCLOUDEAST

    • GOVCLOUDWEST

  • AWS User Pool Id: Insira o ID do pool de usuários AWS.

  • AWS User Pool Client App Id: Insira o ID do aplicativo cliente do pool de usuários AWS.

  • AWS User Pool Client App Secret: Insira o segredo do aplicativo cliente do pool de usuários AWS.

• OAuth: Quando selecionado, mostra configurações adicionais. Para documentação, veja Establishing a connection e Additional configurations properties:

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

    • OFF

    • GETANDREFRESH

    • REFRESH

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

    • Disabled

    • 1.0

    • 2.0

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

  • OAuth Client Secret: Insira o segredo do cliente OAuth.

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

  • OAuth Access Token Secret: Insira o segredo do token de acesso OAuth.

  • Callback URL: Insira a URL de callback.

  • OAuth Grant Type: Selecione o tipo de concessão OAuth, uma das seguintes:

    • CODE

    • CLIENT

    • PASSWORD

  • OAuth Include Callback URL: Quando selecionado (padrão), especifica incluir a URL de callback OAuth.

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

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

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

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

  • Verificador OAuth: Insira o verificador OAuth.

  • Token de Autenticação: Insira o token de autenticação.

  • Chave de Autenticação: Insira a chave de autenticação.

  • Parâmetros OAuth: Insira os parâmetros OAuth.

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

  • Expira em OAuth: Insira o tempo em segundos que o token OAuth expira.

  • Timestamp do Token OAuth: Insira o timestamp do token OAuth.

• JWT OAuth: Quando selecionado, mostra configurações adicionais. Para documentação, veja Estabelecendo uma conexão e Propriedades de configurações adicionais:

  • Certificado JWT OAuth: Insira o certificado JWT OAuth.

  • Tipo de Certificado JWT OAuth: Selecione o tipo de certificado JWT OAuth, um dos:

    • USUÁRIO

    • MÁQUINA

    • ARQUIVO PFX

    • BLOB PFX

    • ARQUIVO JKS

    • BLOB JKS

    • ARQUIVO PEMKEY

    • BLOB PEMKEY

    • ARQUIVO DE CHAVE PÚBLICA

    • BLOB DE CHAVE PÚBLICA

    • ARQUIVO DE CHAVE PÚBLICA SSH

    • BLOB DE CHAVE PÚBLICA SSH

    • ARQUIVO P7B

    • ARQUIVO PPK

    • ARQUIVO XML

    • BLOB XML

  • Senha do Certificado JWT OAuth: Insira a senha do certificado JWT OAuth.

  • Sujeito do Certificado JWT OAuth: Insira o sujeito do certificado JWT OAuth.

  • Emissor JWT OAuth: Insira o emissor JWT OAuth.

  • Sujeito JWT OAuth: Insira o sujeito JWT OAuth.

• SSL: Quando selecionado, mostra configurações adicionais. Para documentação, veja Estabelecendo uma conexão e Propriedades de configurações adicionais:

  • Certificado de Cliente SSL: Insira o certificado de cliente SSL.

  • Tipo de Certificado de Cliente SSL: Selecione o tipo de certificado de cliente SSL, um dos:

    • USUÁRIO

    • MÁQUINA

    • ARQUIVO_PFX

    • BLOB_PFX

    • ARQUIVO_JKS

    • BLOB_JKS

    • ARQUIVO_PEMKEY

    • BLOB_PEMKEY

    • ARQUIVO_CHAVE_PÚBLICA

    • BLOB_CHAVE_PÚBLICA

    • ARQUIVO_CHAVE_PÚBLICA_SSH

    • BLOB_CHAVE_PÚBLICA_SSH

    • ARQUIVO_P7B

    • ARQUIVO_PPK

    • ARQUIVO_XML

    • BLOB_XML

  • Senha do Certificado de Cliente SSL: Insira a senha do certificado de cliente SSL.

  • Assunto do Certificado de Cliente SSL: Insira o assunto do certificado de cliente SSL.

  • Certificado de Servidor SSL: Insira o certificado de servidor SSL.

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

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

  • Adicionar: Adiciona uma linha à tabela. Insira um par chave-valor para cada propriedade.

    Dica

    Para adicionar cabeçalhos a uma conexão GraphQL, especifique um Nome de CustomHeaders e um Valor no formato HeaderName:HeaderValue. Por exemplo, usando a API GraphQL do Braintree para enviar seu cabeçalho Braintree-Version.

  • Enviar: Salva o par chave-valor na tabela. Visível ao passar o mouse sobre uma linha no modo de edição.

  • Descartar: Descartar 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 editar 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

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

  Campos na tabela Propriedades de Configurações Avançadas não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.

• Testar: Clique para verificar a conexão usando a configuração especificada. Quando a conexão é testada, a versão mais recente do conector é baixada pelos agentes no grupo de agentes associado ao ambiente atual. Este conector suporta suspender o download da versão mais recente do conector usando a política de Desativar Atualização Automática do Conector.

• Salvar Alterações: Clique para salvar e fechar a configuração da 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 (veja Dependências de componentes, exclusão e remoção). Uma mensagem pede para você confirmar que deseja excluir a conexão.

Configurar conexões OAuth

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

Para este conector, dois cenários são suportados. Em qualquer um dos cenários, será necessário usar uma ferramenta de terceiros (como Postman ou uma ferramenta similar) para obter o token de acesso necessário ou tokens do endpoint envolvido. Ambos os cenários funcionam apenas para grupos de agentes únicos. Esses 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 definido.

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

  Propriedade de Configuração	Valor
  Iniciar OAuth	OFF
  Token de Acesso OAuth	Definido para o valor do token de acesso OAuth obtido do endpoint

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

  Com esta configuração, o conector usará um token de atualização para obter um novo token de acesso assim que o token de acesso atual tiver expirado. Este é 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 para o valor do token de acesso OAuth obtido do endpoint
  Token de Atualização OAuth	Definido para o valor do token de atualização OAuth obtido do endpoint

Próximas etapas

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

As ações do menu para uma conexão e seus tipos de atividade estão acessíveis no painel do projeto e na paleta de componentes de design. Para mais detalhes, veja Menus de ações em Conceitos básicos do conector.

Estes tipos de atividade estão disponíveis:

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

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