Conexión HTTP v2
Introducción
Una conexión HTTP v2, creada utilizando el conector HTTP v2, establece acceso a través del protocolo HTTP o HTTPS a un servicio como una API REST, API GraphQL o un formulario web. Una vez que se configura una conexión, se pueden crear instancias de actividades HTTP v2 asociadas con esa conexión para ser utilizadas como fuentes (para proporcionar datos en una operación) o como destinos (para consumir datos en una operación).
Nota
Este conector soporta la Política de organización Habilitar re-autenticación al cambiar organization policy. Si está habilitada, un cambio en la URL base, Autorización, Clave o Nombre de usuario en esta conexión requiere que los usuarios vuelvan a ingresar el Valor, Token Bearer, Secreto del cliente o Token de sesión (dependiendo de la Autorización seleccionada) para la conexión.
Crear o editar una conexión HTTP v2
Una nueva conexión HTTP v2 se crea utilizando el conector HTTP v2 desde una de estas ubicaciones:
- La pestaña Puntos finales y conectores del proyecto en la paleta de componentes de diseño (ver Paleta de componentes de diseño).
- La página Puntos finales globales (ver Crear un punto final global en Puntos finales globales).
Una conexión HTTP v2 existente se puede editar desde estas ubicaciones:
- La pestaña Puntos finales y conectores del proyecto en la paleta de componentes de diseño (ver Paleta de componentes de diseño).
- La pestaña Componentes del panel del proyecto (ver Menú de acciones de componentes en Pestaña de componentes del panel del proyecto).
- La página Puntos finales globales (ver Editar un punto final global en Puntos finales globales).
Configurar una conexión HTTP v2
Cada elemento de la interfaz de usuario de la pantalla de configuración de la conexión HTTP v2 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. Comience escribiendo un corchete cuadrado abierto [
en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes de las que elegir.
-
Nombre de la conexión: Ingrese un nombre para identificar la conexión. El nombre debe ser único para cada conexión HTTP v2 y no debe contener barras diagonales
/
ni dos puntos:
. Este nombre también se utiliza para identificar el punto final HTTP v2, que se refiere tanto a una conexión específica como a sus actividades. -
URL base: Ingrese la URL base. La URL base se utiliza para probar la conexión. Si se utiliza este campo en tiempo de ejecución depende de si se completa el campo URL de actividad HTTP de una actividad HTTP v2:
-
Si se proporciona una URL parcial o no se proporciona ninguna URL en el campo URL de actividad HTTP, entonces la URL utilizada en tiempo de ejecución se concatena a partir de la URL base y la URL de actividad HTTP.
-
Si se proporciona una URL completa en el campo URL de actividad HTTP, entonces la URL base no se utiliza en tiempo de ejecución.
-
-
Autorización: Utilice el menú para seleccionar el tipo de autenticación, resumido a continuación. La configuración de cada tipo de autenticación se describe en tipos de autenticación de conexión HTTP v2.
-
Clave API: Especifique un par clave-valor de API para enviar en encabezados o parámetros de consulta.
-
Firma de AWS: Especifique un ID de clave de acceso de AWS, una clave de acceso secreta, región, servicio y token de sesión para enviar utilizando la versión 2 de la firma de Amazon Web Services (AWS) en encabezados o parámetros de consulta.
-
-
Autenticación Básica: Especifica un nombre de usuario y una contraseña para enviar en los encabezados.
-
Token Bearer: Especifica un token bearer para enviar en los encabezados.
-
Autenticación Digest: Especifica un nombre de usuario, contraseña, realm, nonce, algoritmo, QOP, conteo de nonce, nonce del cliente y opaco para enviar en los encabezados.
-
Autenticación Hawk: Especifica un ID de autenticación Hawk, clave de autenticación, información específica de la aplicación, un ID de aplicación y DLG para enviar en los encabezados.
-
Sin Autenticación: Selecciona para acceder al servicio de forma anónima sin autorización.
-
OAuth 2.0: Especifica el tipo de concesión y proporciona el endpoint del token OAuth, ID de cliente, secreto de cliente y alcance para enviar en los encabezados o en el cuerpo de la solicitud.
-
Reintentar: Funcional solo cuando se utiliza un entorno asociado con un grupo de agentes privados, esta configuración se utiliza para reintentar una solicitud cuando un endpoint HTTP v2 devuelve uno de estos códigos de estado:
500
,502
,503
o504
.Esta configuración entra en efecto cuando se utiliza con agentes privados versión 10.34 o posterior.
Selecciona la casilla Reintentar para expandir opciones de configuración adicionales:
-
Intervalo de Reintento (Segundos): Ingresa el número de segundos (máximo de 5 segundos) para esperar entre el reenvío de una solicitud al endpoint HTTP v2.
-
Máximo de Reintentos: Ingresa el número máximo de reintentos (máximo de 5 reintentos) que se reenviará una solicitud al endpoint HTTP v2. Si la solicitud sigue fallando después del número máximo de reintentos, se devolverá una excepción con un mensaje de error en el registro de operaciones. Además, el agente privado registrará cada reintento en el archivo de registro
jitterbit.log
.
-
Cada reintento se trata como parte de la misma ejecución de operación, donde solo aparece un único registro en el registro de operaciones. Cualquier acción de operación configurada para ejecutar operaciones posteriores se activa en función del estado final de la operación después de reintentar hasta el número máximo de reintentos.
-
Configuraciones Opcionales: Haga clic para expandir configuraciones opcionales adicionales:
-
Obtener contenido de respuesta en cadena base64: Seleccione para devolver
responseContent
codificado en base64 de las actividades HTTP v2. -
Configuraciones de Proxy: Use el menú para seleccionar las configuraciones de proxy, una de estas opciones:
-
Personalizado: Las configuraciones de proxy se habilitan utilizando las entradas especificadas en los campos adicionales que se vuelven disponibles cuando se selecciona esta opción. Esta opción omite la configuración de proxy del agente privado si existe.
- Host: Ingrese el nombre del servidor proxy HTTP.
- Puerto: Ingrese el puerto del servidor proxy HTTP.
- Usuario: Ingrese el nombre de usuario para la autenticación del servidor proxy HTTP.
- Contraseña: Ingrese la contraseña para la autenticación del servidor proxy HTTP.
- Dominio NTLM: Ingrese el dominio NTLM para la autenticación del servidor proxy HTTP.
- Permitir Certificados No Verificados Usados por el Proxy: Seleccione para permitir que se utilicen certificados no verificados por el servidor proxy HTTP.
-
Predeterminado: Las configuraciones de proxy están habilitadas, utilizando la configuración de proxy del agente privado si existe. Si no se especifican configuraciones de proxy en la configuración del agente, entonces la configuración Predeterminado tiene el mismo resultado que la configuración Deshabilitar.
-
Deshabilitar: Las configuraciones de proxy están deshabilitadas, omitiendo la configuración de proxy del agente privado si existe.
-
-
Propiedades HTTP Avanzadas: Si es aplicable, establece estas opciones avanzadas:
-
Content-Type: Ingresa el tipo de contenido de la estructura de solicitud que se espera por la API en particular. Por ejemplo,
text/plain
,application/json
,application/x-www-form-urlencoded
, etc. Si el método utilizado no acepta datos estructurados, o si la API no requiere que se especifique el tipo de contenido, deja este campo en blanco. Este campo no se ve afectado por la configuración Enviar encabezados de solicitud en la ejecución de la actividad.Alternativamente, el tipo de contenido puede especificarse en otros campos de configuración de la interfaz de usuario o proporcionarse en la transformación de la solicitud. Si el tipo de contenido se especifica en múltiples lugares, se sigue este orden de precedencia:
- Un encabezado
Content-Type
proporcionado en la tabla de Configuraciones Adicionales de una actividad HTTP v2 anula todos los campos a continuación. - El campo
bodyContentType
especificado en una transformación de solicitud anula los campos restantes a continuación. - Un encabezado
Content-Type
proporcionado en el nodoheaders
de la transformación de solicitud anula los campos restantes a continuación. - Un encabezado
Content-Type
proporcionado en el campo Encabezados de Solicitud de una actividad HTTP v2 anula el campo restante a continuación. - Un encabezado
Content-Type
proporcionado en el campo Encabezados de Solicitud de una conexión HTTP v2, si Enviar Encabezados de Solicitud en la Ejecución de la Actividad está habilitado, tiene la menor precedencia.
Nota
Si un encabezado se define en múltiples ubicaciones, cada instancia del encabezado se agregará a la solicitud de una actividad siguiendo el orden de precedencia anterior. Este orden se basa en cómo los servicios manejan típicamente los encabezados duplicados en una solicitud.
- Un encabezado
-
Habilitar codificación de contenido: Selecciona para enviar el encabezado
Accept-Encoding
con codificación Gzip. Este campo no se ve afectado por la configuración Enviar Encabezados de Solicitud en la Ejecución de la Actividad.Alternativamente, este encabezado puede definirse en otros campos de configuración de la interfaz de usuario o proporcionarse en la transformación de la solicitud. Si este encabezado se especifica en múltiples lugares, se sigue este orden de precedencia:
- Un encabezado
Accept-Encoding
proporcionado en el nodoheaders
de la transformación de solicitud anula todos los campos a continuación. - Un encabezado
Accept-Encoding
proporcionado en el campo Request Headers de una actividad HTTP v2 anula el campo restante a continuación. - Un encabezado
Accept-Encoding
proporcionado en el campo Request Headers de una conexión HTTP v2, si Send Request Headers in Activity Execution está habilitado, tiene la menor precedencia.
Nota
Si un encabezado se define en múltiples ubicaciones, cada instancia del encabezado se añadirá a la solicitud de una actividad siguiendo el orden de precedencia anterior. Este orden se basa en cómo los servicios manejan típicamente los encabezados duplicados en una solicitud.
- Un encabezado
-
Habilitar codificación de transferencia en fragmentos: Seleccione para enviar el encabezado
Transfer-Encoding: chunked
. Utilice esta opción si está transfiriendo grandes conjuntos de datos. Este campo no se ve afectado por la configuración Send Request Headers in Activity Execution.Alternativamente, este encabezado puede definirse en otros campos de configuración de la interfaz de usuario o proporcionarse en la transformación de solicitud. Si este encabezado se especifica en múltiples lugares, se sigue este orden de precedencia:
- Un encabezado
Transfer-Encoding
proporcionado en el nodoheaders
de la transformación de solicitud anula todos los campos a continuación. - Un encabezado
Transfer-Encoding
proporcionado en el campo Request Headers de una actividad HTTP v2 anula el campo restante a continuación. - Un encabezado
Transfer-Encoding
proporcionado en el campo Request Headers de una conexión HTTP v2, si Send Request Headers in Activity Execution está habilitado, tiene la menor precedencia.
Nota
Si un encabezado se define en múltiples ubicaciones, cada instancia del encabezado se añadirá a la solicitud de una actividad siguiendo el orden de precedencia anterior. Este orden se basa en cómo los servicios manejan típicamente los encabezados duplicados en una solicitud.
- Un encabezado
-
Permitir cifrados débiles: Esta opción no está actualmente funcional.
-
Mantener viva: Seleccione para permitir que una única conexión TCP permanezca abierta para múltiples solicitudes y respuestas HTTP.
-
Verificación del certificado SSL: Seleccione para verificar el servicio validando el certificado SSL / TLS presentado durante el proceso de apretón de manos.
-
Codificar URL de solicitud: Seleccione para codificar la URL de la solicitud.
-
Seguir redirecciones: Seleccione para permitir que el conector redirija con cualquier redirección presente en la URL base. Si la URL base redirige y esta configuración no está seleccionada, ocurrirá un error al probar la conexión y en la primera ejecución de una operación. Cuando esta opción está seleccionada, el siguiente campo se vuelve visible:
- Número máximo de redirecciones: Ingrese la cantidad de redirecciones que la conexión seguirá antes de devolver un error.
-
Solo aplicable al usar HTTPS: Use el menú para cambiar la selección de Negociar (predeterminado) a una versión específica de TLS si es necesario, seleccionando entre TLSv1.0, TLSv1.1, TLSv1.2 o TLSv1.3.
-
Encabezados de solicitud: Defina los encabezados HTTP para la conexión. Haga clic en el ícono de agregar para añadir un encabezado a la tabla a continuación e ingrese un par clave-valor para cada parámetro de solicitud.
Para guardar la fila, haga clic en el ícono de enviar 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 editar o el ícono de eliminar .
Para eliminar todas las filas, haga clic en Limpiar todo.
Alternativamente, los encabezados se pueden definir en otros campos de configuración de la interfaz de usuario o proporcionarse en la transformación de solicitud. Los encabezados que no comparten una clave se envían de manera acumulativa, independientemente de dónde se especifiquen.
Si la misma clave de encabezado se especifica en múltiples lugares, se sigue este orden de precedencia:
- Un encabezado proporcionado en el nodo
headers
de la transformación de solicitud anula todos los campos a continuación. - Un encabezado proporcionado en el campo Encabezados de solicitud de una actividad HTTP v2 anula el campo restante a continuación.
- Un encabezado proporcionado en el campo Encabezados de solicitud de una conexión HTTP v2 (este campo), si Enviar encabezados de solicitud en la ejecución de actividad está habilitado, tiene la menor precedencia.
Nota
Si un encabezado está definido en múltiples ubicaciones, cada instancia del encabezado se añadirá a la solicitud de una actividad siguiendo el orden de precedencia anterior. Este orden se basa en cómo los servicios manejan típicamente los encabezados duplicados en una solicitud.
Advertencia
No defina manualmente los encabezados de solicitud
Authorization
en actividades HTTP v2 si la conexión HTTP v2 está configurada para enviar sus propios encabezados de solicitudAuthorization
dependiendo del tipo de autenticación seleccionado. Hacerlo resulta en la terminación de la operación y falla antes de alcanzar el punto final objetivo y se registra como un error400 Bad Request
.Si se requiere autenticación dinámica a nivel de actividad, establezca el tipo de autenticación de la conexión en No Auth y configure los encabezados de solicitud
Authorization
de la actividad según sea necesario.Importante
Los campos en la tabla de Request Headers 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 Request Headers no admiten el uso de variables para pasar JSON sin procesar. Si su caso de uso no admite definir JSON sin procesar en los campos directamente, escape el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar
{"success": "true"};
se convierte en{\"success\": \"true\"};
. - Un encabezado proporcionado en el nodo
-
Enviar encabezados de solicitud en la ejecución de la actividad: Seleccione pasar los encabezados definidos en Request Headers a actividades HTTP v2. Consulte los órdenes de precedencia anteriores para determinar cómo los encabezados definidos en una conexión HTTP v2 interactúan con los encabezados definidos en otras ubicaciones.
-
-
-
Probar: Haga clic para verificar la conexión enviando una solicitud HTTP GET utilizando la autorización configurada. Una prueba se considera exitosa si se devuelve cualquier código de estado HTTP 2xx. Una respuesta
405 Method Not Allowed
también se trata como exitosa. 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. -
Guardar cambios: Haga clic para guardar y cerrar la configuración de la 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 pide 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 le pide que confirme que desea eliminar la conexión.
Siguientes pasos
Después de que se ha creado una conexión HTTP v2, 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 Menús de acciones en Conceptos básicos del conector.
Estos tipos de actividad están disponibles:
-
PATCH: Aplica modificaciones parciales a un recurso existente en un servicio accesible a través del protocolo HTTP o HTTPS y se puede utilizar como fuente o destino en una operación.
-
HEAD: Recupera la línea de estado y la sección de encabezado de un recurso en un servicio accesible a través del protocolo HTTP o HTTPS y se puede utilizar como fuente o destino en una operación.
-
POST: Crea un nuevo recurso en un servicio accesible a través del protocolo HTTP o HTTPS y se puede utilizar como fuente o destino en una operación.
-
GET: Recupera información sobre un recurso en un servicio accesible a través del protocolo HTTP o HTTPS y se puede utilizar como fuente o destino en una operación.
-
OPTIONS: Recupera información sobre las opciones de comunicación para un recurso en un servicio accesible a través del protocolo HTTP o HTTPS y se puede utilizar como fuente o destino en una operación.
-
BULK: Envía múltiples solicitudes a un servicio accesible a través del protocolo HTTP o HTTPS y se puede utilizar como fuente o destino en una operación.
-
DELETE: Elimina un recurso en un servicio accesible a través del protocolo HTTP o HTTPS y se puede utilizar como fuente o destino en una operación.
-
PUT: Reemplaza un recurso existente en un servicio accesible a través del protocolo HTTP o HTTPS y se puede utilizar como fuente o destino en una operación.