Saltar al contenido

Conexión GraphQL

Introducción

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

Importante

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

Crear o Editar una Conexión GraphQL

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

Se puede editar una conexión GraphQL existente desde estas ubicaciones:

Configurar una Conexión GraphQL

A continuación se describe cada elemento de la interfaz de usuario de la pantalla de configuración de conexión GraphQL.

Sugerencia

Campos con un ícono de variable Ícono de variable admite el uso de variables globales, variables del proyecto y variables Jitterbit. Comience escribiendo un corchete abierto [ en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes para elegir.

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

  • Autenticación: Cuando se selecciona (predeterminado), se muestran configuraciones adicionales. Para obtener documentación, consulte Establecer una conexión y Propiedades de configuraciones adicionales:

    • Esquema de autenticación: Seleccione el esquema de autorización, uno de los siguientes:

      • Ninguno

      • Básico

      • OAuth

      • AwsCognitoSrp

      • AwsCognitoBasic

    • URL: Ingrese la URL.

    • Usuario: Ingrese el usuario.

    • Contraseña: Ingrese la contraseña.

  • Autenticación de AWS: Cuando se selecciona, se muestran configuraciones adicionales. Para obtener documentación, consulte Establecer una conexión y Propiedades de configuraciones adicionales:

    • Región de AWS Cognito: Seleccione la región de AWS Cognito, una de las siguientes:

      • OHIO

      • NORTE DE VIRGINIA

      • NORTE DE CALIFORNIA

      • OREGÓN

      • CIUDAD DEL CABO

      • HONG KONG

      • BOMBAY

      • OSAKA

      • SEÚL

      • SINGAPUR

      • SÍDNEY

      • TOKIO

      • CENTRAL

      • PEKÍN

      • NINGXIA

      • FRANCFORT

      • IRLANDA

      • LONDRES

      • MILÁN

      • PARÍS

      • ESTOCOLMO

      • BAHRÉIN

      • SAOPAULO

      • GOVCLOUDEAST

      • GOVCLOUDWEST

    • ID de grupo de usuarios de AWS: Ingrese el ID de grupo de usuarios de AWS.

    • ID de aplicación cliente de grupo de usuarios de AWS: Ingrese el ID de aplicación cliente de grupo de usuarios de AWS.

    • Secreto de aplicación cliente del grupo de usuarios de AWS: Ingrese el secreto de aplicación cliente del grupo de usuarios de AWS.

  • OAuth: Cuando se selecciona, se muestran configuraciones adicionales. Para obtener documentación, consulte Establecer una conexión y Propiedades de configuraciones adicionales:

    • Iniciar OAuth: Seleccione la configuración de OAuth, una de las siguientes:

      • DESACTIVADO

      • RECIÉNDETE Y REFRESCATE

      • ACTUALIZACIÓN

    • Versión de OAuth: Seleccione la versión de OAuth, una de las siguientes:

      • Deshabilitado

      • 1,0

      • 2.0

    • Id. de cliente OAuth: Ingrese el ID de cliente OAuth.

    • Secreto de cliente OAuth: Ingrese el secreto de cliente OAuth.

    • Token de acceso OAuth: Ingrese el token de acceso OAuth.

    • Secreto del token de acceso OAuth: Ingrese el secreto del token de acceso OAuth.

    • URL de devolución de llamada: Ingrese la URL de devolución de llamada.

    • Tipo de concesión de OAuth: Seleccione el tipo de concesión de OAuth, uno de los siguientes:

      • CÓDIGO

      • CLIENTE

      • CONTRASEÑA

    • OAuth Include Callback URL: Cuando se selecciona (predeterminado), especifica que se incluirá la URL de devolución de llamada de OAuth.

    • URL de autorización de OAuth: Ingrese la URL de autorización de OAuth.

    • URL del token de acceso OAuth: Ingrese la URL del token de acceso OAuth.

    • URL del token de actualización de OAuth: Ingrese la URL del token de actualización de OAuth.

    • URL del token de solicitud de OAuth: Ingrese la URL del token de solicitud de OAuth.

    • Verificador OAuth: Ingrese el verificador OAuth.

    • Token de autenticación: Ingrese el token de autenticación.

    • Clave de autenticación: Ingrese la clave de autenticación.

    • Parámetros OAuth: Ingrese los parámetros OAuth.

    • Token de actualización de OAuth: Ingrese el token de actualización de OAuth.

    • OAuth caduca en: Ingrese el tiempo en segundos en el que caduca el token OAuth.

    • Marca de tiempo del token OAuth: Ingrese la marca de tiempo del token OAuth.

  • JWT OAuth: Cuando se selecciona, se muestran configuraciones adicionales. Para obtener documentación, consulte Establecer una conexión y Propiedades de configuraciones adicionales:

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

    • Tipo de certificado JWT de OAuth: Seleccione el tipo de certificado JWT de OAuth, uno de los siguientes:

      • USUARIO

      • MÁQUINA

      • PFXFILE

      • PFXBLOB

      • JKSFILE

      • JKSBLOB

      • ARCHIVO_DE_CLAVE_PEM

      • BLOB_DE_CLAVE_PÚBLICA

      • BLOB_DE_CLAVE_PÚBLICA

      • ARCHIVO_DE_CLAVE_PÚBLICA

      • ARCHIVO_DE_CLAVE_PÚBLICA_SSHP

      • SSHPUBLIC_KEY_BLOB

      • P7BFILE

      • PPKFILE

      • XMLFILE

      • XMLBLOB

    • OAuth JWT Cert Password: Ingrese la contraseña del certificado OAuth JWT.

    • OAuth JWT Certificate Subject: Ingrese el asunto del certificado OAuth JWT.

    • OAuth JWT Issuer: Ingrese el emisor de OAuth JWT.

    • OAuth JWT Subject: Ingrese el asunto de OAuth JWT.

  • SSL: Cuando se selecciona, se muestran configuraciones adicionales. Para obtener documentación, consulte Establecer una conexión y Propiedades de configuraciones adicionales:

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

    • Tipo de certificado de cliente SSL: Seleccione el tipo de certificado de cliente SSL, uno de los siguientes:

      • USUARIO

      • MÁQUINA

      • PFXFILE

      • PFXBLOB

      • JKSFILE

      • JKSBLOB

      • ARCHIVO_DE_CLAVE_PEM

      • BLOB_DE_CLAVE_PÚBLICA

      • BLOB_DE_CLAVE_PÚBLICA

      • ARCHIVO_DE_CLAVE_PÚBLICA

      • ARCHIVO_DE_CLAVE_PÚBLICA_SSHP

      • SSHPUBLIC_KEY_BLOB

      • P7BFILE

      • PPKFILE

      • XMLFILE

      • XMLBLOB

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

    • Asunto del certificado de cliente SSL: Ingrese el asunto del certificado de cliente SSL.

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

  • Usar configuración de proxy: Seleccione para utilizar configuración de proxy de agente privado.

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

    Haga clic en el ícono de agregar ícono de agregar para agregar una fila a la tabla siguiente e ingresar un par clave-valor para cada propiedad.

    Para guardar la fila, haga clic en el ícono de envío icono de envío en la columna más a la derecha.

    Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de edición ícono de edición o eliminar icono eliminar icono.

    Para eliminar todas las filas, haga clic en Borrar todo.

    Importante

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

  • Prueba: Haga clic para verificar la conexión utilizando la configuración especificada. Cuando se prueba la conexión, los agentes del grupo de agentes asociado con el ambiente actual descargan la última versión del conector. Este conector admite la suspensión de la descarga de la última versión del conector mediante la política de la organización Deshabilitar actualización automática del conector.

  • Guardar cambios: Haga clic para guardar y cerrar la configuración de conexión.

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

  • Eliminar: 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 te pedirá que confirmes que deseas eliminar la conexión.

Configurar Conexiones OAuth

Este conector admite una conexión mediante 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

Es posible que se requieran identificadores, secretos, ámbitos y otros tokens de autenticación adicionales para completar con éxito la autenticación OAuth. Consulte la documentación del extremo para obtener información adicional sobre sus requisitos.

Para este conector, se admiten dos escenarios. En cualquiera de los dos, deberá utilizar una herramienta de externo (como Postman o una herramienta similar) para obtener el token o los tokens de acceso necesarios del extremo 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 caduca después de un período de tiempo determinado.

    Con esta configuración, se proporciona un token de acceso OAuth que dura un período de tiempo determinado, según lo determine el extremo en particular. El conector utilizará el token para realizar la conexión. Sin embargo, la conexión dejará de funcionar una vez que caduque el token de acceso. Para configurar el conector para que utilice el token, debe configurar estas propiedades:

    Propiedad de configuración Valor
    Iniciar OAuth OFF
    Token de acceso OAuth Establezca el valor del token de acceso OAuth obtenido del extremo

  • 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 suele ser el mejor método para configurar OAuth.

    Debe proporcionar un token de acceso OAuth y un token de actualización OAuth, según lo determine el extremo en particular. Debe configurar el conector para que use estos tokens configurando estas propiedades:

    Propiedad de configuración Valor
    Iniciar OAuth REFRESH
    Token de acceso OAuth Establezca el valor del token de acceso OAuth obtenido del extremo
    Token de actualización de OAuth Establezca el valor del token de actualización de OAuth obtenido del extremo

Nota

Si utiliza varias conexiones 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 jitterbit.conf archivo para el agente, establezca EnableLocalFileLocation=true Si no realiza estos dos pasos, las conexiones múltiples utilizarán la misma ruta predeterminada y se sobrescribirán entre sí.

Próximos Pasos

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

Se puede acceder a las acciones del menú de una conexión y sus tipos de actividad desde el panel de proyecto y la paleta de componentes de diseño. Para obtener más información, consulte Menús de acciones en Conceptos básicos del conector.

Están disponibles estos tipos de actividades:

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

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