Conector API para Jitterbit Studio

Resumen

El conector API expone una operación o un conjunto de operaciones como un punto final REST consumible. Viene con una conexión preconfigurada que no requiere configuración de conexión, como es típico en la mayoría de los conectores de Harmony. Esta conexión proporciona acceso a actividades de API que, una vez configuradas, interactúan con APIs personalizadas configuradas en Jitterbit API Manager.

El conector API se accede desde la pestaña Puntos finales y conectores del componente de diseño en la paleta de componentes de diseño (ver Paleta de componentes de diseño).

Para obtener información sobre la relación entre las actividades del conector API y las APIs del API Manager, consulte estos recursos:

• Tipos de API del API Manager

• Configuración de API personalizada

• Construyendo una API personalizada simple

Descripción general del conector

Este conector está destinado a ser utilizado junto con una API Manager custom API para exponer una operación o un conjunto de operaciones como un endpoint REST consumible.

Los tipos de actividad se utilizan para crear instancias de actividades que están destinadas a ser utilizadas como fuentes (para proporcionar datos en una operación) o destinos (para consumir datos en una operación).

Juntos, la conexión API preconfigurada y sus actividades se denominan un endpoint API:

• Request: Configurada utilizando un esquema JSON, XML, CSV o XSD, esta actividad recupera datos cuando es llamada por una API Manager custom API y está destinada a ser utilizada como una fuente para proporcionar datos a una operación.

• Response: Configurada utilizando un esquema JSON, XML, CSV o XSD, esta actividad devuelve datos a una API Manager custom API y está destinada a ser utilizada como un destino para consumir datos en una operación.

• SOAP Request: Configurada utilizando un esquema WSDL, esta actividad recupera datos cuando es llamada por una API Manager custom API y está destinada a ser utilizada como una fuente para proporcionar datos a una operación.

• SOAP Response: Configurada utilizando un esquema WSDL, esta actividad devuelve datos a una API Manager custom API y está destinada a ser utilizada como un destino para consumir datos en una operación.

Los endpoints creados con este conector no cuentan para tu licencia y no están incluidos en el informe de uso de endpoints.

Variables de API Jitterbit

Estas variables de Jitterbit se proporcionan específicamente para su uso con endpoints de API:

• jitterbit.api.request.body y jitterbit.api.request.body.*

• jitterbit.api.request.enum.body

• jitterbit.api.request.enum.headers

• jitterbit.api.request.enum.mvparameters

• jitterbit.api.request.enum.parameters

• jitterbit.api.request.headers.*

• jitterbit.api.request.headers.fulluri

• jitterbit.api.request.method

• jitterbit.api.request.mvparameters.*

• jitterbit.api.request.parameters.*

• jitterbit.api.response

• jitterbit.api.response.headers.*

• jitterbit.api.response.headers.content_type

  Nota

  Cuando un endpoint requiere una codificación de caracteres específica, jitterbit.source.text.character_encoding y jitterbit.target.text.character_encoding también pueden ser necesarios. Estos, junto con cualquier variable que afecte la respuesta de la API, deben configurarse en un script antes de cualquier transformación en la operación. Esto incluye variables como jitterbit.api.response.headers.content_type.

• jitterbit.api.response.status_code

Solución de problemas

Si experimenta problemas con el conector de la API, se recomiendan los siguientes pasos de solución de problemas:

1. Asegúrese de que la conexión de la API sea exitosa utilizando el botón Probar en la pantalla de configuración. Si la conexión no es exitosa, el error devuelto puede proporcionar una indicación del problema.

2. Revise los registros de operaciones para cualquier información escrita durante la ejecución de la operación.

3. Habilite el registro de depuración de operaciones (para agentes en la nube o para agentes privados) para generar archivos de registro y datos adicionales.

4. Si utiliza agentes privados, puede revisar los registros de agentes para obtener más información.

5. Para consideraciones adicionales de solución de problemas, consulte Solución de problemas de operaciones.

6. Solicitud SOAP y Actividades de respuesta SOAP: Al implementar una operación cuyo archivo WSDL de la actividad Solicitud SOAP o Respuesta SOAP ha sido reemplazado, puede recibir este error:

   Falló la implementación - Error del cliente: No hay ningún archivo subido con la ruta del cliente ... Actualice a la versión 8.4.0 del Studio o superior y despliegue el proyecto nuevamente.

   Para resolver, siga estos pasos:

   1. Abra la actividad donde se ha reemplazado el archivo WSDL.

   2. En el paso 1, vuelva a seleccionar el archivo WSDL que se utilizará para la actividad y luego haga clic en Siguiente.

   3. En el paso 2, haga clic en Finalizar.

   4. Despliegue la operación.