Saltar al contenido

Conexión GraphQL

Introducción

Una conexión GraphQL, creada utilizando el conector GraphQL, establece acceso a GraphQL. Estas actividades, una vez configuradas, interactúan con GraphQL a través de la conexión.

Importante

Se recomienda utilizar el conector GraphQL v2 para conectarse a GraphQL ya que permite propiedades de configuración adicionales.

Crear o editar una conexión GraphQL

Una nueva conexión GraphQL se crea utilizando el conector GraphQL desde una de estas ubicaciones:

Una conexión GraphQL existente se puede editar desde estas ubicaciones:

Configurar una conexión GraphQL

Cada elemento de la interfaz de usuario de la pantalla de configuración de la conexión GraphQL se describe a continuación.

Consejo

Los campos con un ícono de variable admiten el uso de variables globales, variables de proyecto y variables de Jitterbit. Comienza escribiendo un corchete cuadrado abierto [ en el campo o haciendo clic en el ícono de variable para mostrar un menú con las variables existentes de las que puedes elegir.

  • Nombre de la Conexión: Ingresa un nombre para identificar la conexión. El nombre debe ser único para cada conexión GraphQL y no debe contener barras diagonales (/) ni dos puntos (:). Este nombre también se utiliza para identificar el punto final de GraphQL, que se refiere tanto a una conexión específica como a sus actividades.

  • Autenticación: Cuando está seleccionado (por defecto), muestra configuraciones adicionales. Para documentación, consulta Estableciendo una conexión y Propiedades de configuraciones adicionales:

    • Esquema de Autenticación: Selecciona el esquema de autorización, uno de:

      • Ninguno

      • Básico

      • OAuth

      • AwsCognitoSrp

      • AwsCognitoBasic

    • URL: Ingresa la URL.

    • Usuario: Ingresa el usuario.

    • Contraseña: Ingresa la contraseña.

  • Autenticación de AWS: Cuando está seleccionado, muestra configuraciones adicionales. Para documentación, consulta Estableciendo una conexión y Propiedades de configuraciones adicionales:

    • Región de AWS Cognito: Selecciona la región de AWS Cognito, una de:

      • OHIO

      • VIRGINIANORTE

      • CALIFORNIANORTE

      • OREGON

      • CABEZA DE CABO

      • HONGKONG

      • MUMBAI

      • OSAKA

      • SEOUL

      • SINGAPORE

      • SYDNEY

      • TOKYO

      • CENTRAL

      • BEIJING

      • NINGXIA

      • FRANKFURT

      • IRELAND

      • LONDON

      • MILAN

      • PARIS

      • STOCKHOLM

      • BAHRAIN

      • SAOPAULO

      • GOVCLOUDEAST

      • GOVCLOUDWEST

    • AWS User Pool Id: Ingresa el ID del grupo de usuarios de AWS.

    • AWS User Pool Client App Id: Ingresa el ID de la aplicación cliente del grupo de usuarios de AWS.

    • AWS User Pool Client App Secret: Ingresa el secreto de la aplicación cliente del grupo de usuarios de AWS.

  • OAuth: Cuando se selecciona, muestra configuraciones adicionales. Para documentación, consulta Estableciendo una conexión y Propiedades de configuraciones adicionales:

    • Initiate OAuth: Selecciona la configuración de OAuth, una de:

      • OFF

      • GETANDREFRESH

      • REFRESH

    • OAuth Version: Selecciona la versión de OAuth, una de:

      • Deshabilitado

      • 1.0

      • 2.0

    • OAuth Client Id: Ingresa el ID del cliente OAuth.

    • OAuth Client Secret: Ingresa el secreto del cliente OAuth.

    • OAuth Access Token: Ingresa el token de acceso OAuth.

    • OAuth Access Token Secret: Ingresa el secreto del token de acceso OAuth.

    • Callback URL: Ingresa la URL de callback.

    • OAuth Grant Type: Selecciona el tipo de concesión de OAuth, uno de:

      • CODE

      • CLIENT

      • PASSWORD

    • OAuth Include Callback URL: Cuando se selecciona (por defecto), especifica incluir la URL de callback de OAuth.

    • OAuth Authorization URL: Ingresa la URL de autorización de OAuth.

    • OAuth Access Token URL: Ingresa la URL del token de acceso OAuth.

    • URL de Token de Actualización de OAuth: Ingresa la URL del token de actualización de OAuth.

    • URL de Token de Solicitud de OAuth: Ingresa la URL del token de solicitud de OAuth.

    • Verificador de OAuth: Ingresa el verificador de OAuth.

    • Token de Autenticación: Ingresa el token de autenticación.

    • Clave de Autenticación: Ingresa la clave de autenticación.

    • Parámetros de OAuth: Ingresa los parámetros de OAuth.

    • Token de Actualización de OAuth: Ingresa el token de actualización de OAuth.

    • Expira en OAuth: Ingresa el tiempo en segundos que expira el token de OAuth.

    • Marca de Tiempo del Token de OAuth: Ingresa la marca de tiempo del token de OAuth.

  • JWT OAuth: Cuando se selecciona, muestra configuraciones adicionales. Para documentación, consulta Estableciendo una conexión y Propiedades de configuraciones adicionales:

    • Certificado JWT de OAuth: Ingresa el certificado JWT de OAuth.

    • Tipo de Certificado JWT de OAuth: Selecciona el tipo de certificado JWT de OAuth, uno de:

      • USUARIO

      • MÁQUINA

      • ARCHIVO_PFX

      • BLOB_PFX

      • ARCHIVO_JKS

      • BLOB_JKS

      • ARCHIVO_PEMKEY

      • BLOB_PEMKEY

      • ARCHIVO_CLAVE_PUBLICA

      • BLOB_CLAVE_PUBLICA

      • ARCHIVO_CLAVE_PUBLICA_SSH

      • BLOB_CLAVE_PUBLICA_SSH

      • ARCHIVO_P7B

      • ARCHIVO_PPK

      • ARCHIVO_XML

      • BLOB_XML

    • Contraseña del Certificado JWT de OAuth: Ingresa la contraseña del certificado JWT de OAuth.

    • Sujeto del Certificado JWT de OAuth: Ingresa el sujeto del certificado JWT de OAuth.

    • Emisor del Certificado JWT de OAuth: Ingresa el emisor del certificado JWT de OAuth.

    • Sujeto del JWT de OAuth: Ingresa el sujeto del JWT de OAuth.

  • SSL: Cuando se selecciona, muestra configuraciones adicionales. Para documentación, consulta Estableciendo una conexión y Propiedades de configuraciones adicionales:

    • Certificado de cliente SSL: Ingresa el certificado de cliente SSL.

    • Tipo de certificado de cliente SSL: Selecciona el tipo de certificado de cliente SSL, uno de:

      • USUARIO

      • MÁQUINA

      • PFXFILE

      • PFXBLOB

      • JKSFILE

      • JKSBLOB

      • PEMKEY_FILE

      • PEMKEY_BLOB

      • PUBLIC_KEY_FILE

      • PUBLIC_KEY_BLOB

      • SSHPUBLIC_KEY_FILE

      • SSHPUBLIC_KEY_BLOB

      • P7BFILE

      • PPKFILE

      • XMLFILE

      • XMLBLOB

    • Contraseña del certificado de cliente SSL: Ingresa la contraseña del certificado de cliente SSL.

    • Sujeto del certificado de cliente SSL: Ingresa el sujeto del certificado de cliente SSL.

    • Certificado de servidor SSL: Ingresa el certificado de servidor SSL.

  • Usar configuraciones de proxy: Selecciona para usar configuraciones de proxy de agente privado.

  • Configuraciones avanzadas: Al seleccionarse, muestra la tabla de Propiedades de configuraciones avanzadas, que se utiliza para agregar propiedades de configuración adicionales como pares clave-valor.

    • Agregar: Agrega una fila a la tabla. Ingresa un par clave-valor para cada propiedad.

      Consejo

      Para agregar encabezados a una conexión GraphQL, especifica un Nombre de CustomHeaders y un Valor en el formato de HeaderName:HeaderValue. Por ejemplo, usando la API GraphQL de Braintree para enviar su encabezado Braintree-Version.

    • Enviar: Guarda el par clave-valor en la tabla. Visible al pasar el cursor sobre una fila en modo de edición.

    • Descartar: Descarta una nueva fila o cualquier edición realizada en una fila existente. Visible al pasar el cursor sobre una fila en modo de edición.
    • Editar: Permite editar un par clave-valor existente. Visible al pasar el cursor sobre una fila existente.
    • Eliminar: Elimina la fila de la tabla. Visible al pasar el cursor sobre una fila existente.
    • Limpiar todo: Elimina todas las filas de la tabla.

    Importante

    Los campos en la tabla de Propiedades de Configuraciones Avanzadas muestran el ícono de variable solo en modo de edición. Para que los valores de variable de estos campos se completen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

    Los campos en la tabla de Propiedades de Configuraciones Avanzadas no admiten el uso de variables para pasar JSON sin procesar. Si su caso de uso no admite definir JSON sin procesar directamente en los campos, escape el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

  • Test: Haga clic para verificar la conexión utilizando la configuración especificada. Cuando se prueba la conexión, la última versión del conector es descargada por el(los) agente(s) en el grupo de agentes asociado con el entorno actual. Este conector admite suspender la descarga de la última versión del conector utilizando la política de organización Deshabilitar Actualización Automática del Conector.

  • Save Changes: Haga clic para guardar y cerrar la configuración de la conexión.

  • Discard Changes: Después de realizar cambios en una configuración nueva o existente, haga clic para cerrar la configuración sin guardar. Un mensaje le pide que confirme que desea descartar los cambios.

  • Delete: Después de abrir una configuración de conexión existente, haga clic para eliminar permanentemente la conexión del proyecto y cerrar la configuración (consulte Dependencias de componentes, eliminación y remoción). Un mensaje le pide que confirme que desea eliminar la conexión.

Configure OAuth connections

Este conector admite una conexión utilizando OAuth mediante propiedades de configuración específicas. Después de seleccionar un esquema de autenticación que incluya Iniciar OAuth, podrá especificar la configuración en los campos que se muestran.

Nota

Se pueden requerir IDs adicionales, secretos, ámbitos y otros tokens de autenticación para completar con éxito la autenticación OAuth. Consulta la documentación del endpoint para obtener información adicional sobre sus requisitos.

Para este conector, se admiten dos escenarios. En cualquiera de los escenarios, necesitarás utilizar una herramienta de terceros (como Postman o una herramienta similar) para obtener el token de acceso requerido o los tokens del endpoint involucrado. Ambos escenarios funcionan solo para grupos de un solo agente. Estos son grupos de agentes que consisten en un solo agente.

  • Escenario 1: Usar un token de acceso OAuth que expira después de un período de tiempo determinado.

    Con esta configuración, proporcionas un token de acceso OAuth que dura un período de tiempo determinado, según lo establecido por el endpoint particular. El conector utilizará el token para realizar la conexión. Sin embargo, la conexión dejará de funcionar una vez que el token de acceso expire. Configurarías el conector para usar el token estableciendo estas propiedades:

    Propiedad de Configuración Valor
    Iniciar OAuth OFF
    Token de Acceso OAuth Establecer al valor del token de acceso OAuth obtenido del endpoint

  • Escenario 2: Usar un token de acceso OAuth combinado con un token de actualización OAuth para habilitar la actualización automática del acceso.

    Con esta configuración, el conector utilizará un token de actualización para obtener un nuevo token de acceso una vez que el token de acceso actual haya expirado. Este es generalmente el mejor método para configurar OAuth.

    Proporcionas un token de acceso OAuth y un token de actualización OAuth, según lo determinado por el endpoint particular. Configurarías el conector para usar estos tokens estableciendo estas propiedades:

    Propiedad de Configuración Valor
    Iniciar OAuth REFRESH
    Token de Acceso OAuth Establecer al valor del token de acceso OAuth obtenido del endpoint
    Token de Actualización OAuth Establecer al valor del token de actualización OAuth obtenido del endpoint

Nota

Si se utilizan múltiples conexiones de GraphQL basadas en OAuth en el mismo agente privado, configure la propiedad de configuración OAuthSettingsLocation a una ruta de agente única y escribible para cada conexión. En el archivo jitterbit.conf para el agente, establezca EnableLocalFileLocation=true. Si no realiza estos dos pasos, las múltiples conexiones utilizarán la misma ruta predeterminada y se sobrescribirán entre sí.

Next steps

Después de que se haya creado una conexión de conector GraphQL, se coloca un tipo de actividad en el lienzo de diseño para crear instancias de actividad que se utilizarán como fuentes (para proporcionar datos en una operación) o como destinos (para consumir datos en una operación).

Las acciones del menú para una conexión y sus tipos de actividad son accesibles desde el panel del proyecto y la paleta de componentes de diseño. Para más detalles, consulte Acciones del menú en Conceptos básicos del conector.

Estos tipos de actividad están disponibles:

  • Query: Recupera registros de una tabla en GraphQL y está destinado a ser utilizado como fuente en una operación.

  • Execute: Ejecuta un procedimiento en GraphQL y está destinado a ser utilizado como destino en una operación.