Saltar al contenido

¡Transforma tus conexiones en dinero para el final del año con nuestro nuevo Programa de Indicación de Clientes! Descubre más

✕

Publicar una operación como API en Jitterbit Integration Studio

Introducción

Esta página describe cómo configurar y publicar una API personalizada (para exponer una operación para su consumo) desde Integration Studio. La opción Publicar como API está disponible desde el menú de acciones de la operación.

Alternativamente, se pueden crear APIs personalizadas desde el API Manager APIs página.

Nota

Una vez publicada, una API personalizada cuenta como una URL de API en su asignación de suscripción de Harmony.

Las APIs personalizadas (publicadas y borradores) se muestran en estas ubicaciones:

  • Las APIs página del API Manager.
  • La pestañaRecursos del panel del proyecto para el proyecto de Integration Studio asociado con la API personalizada.

Prerrequisitos

Para utilizar la opción Publicar como API en el menú de acciones de la operación, se deben cumplir estos requisitos previos:

Configurar la API

Después de hacer clic en la opción Publicar como API en el menú de acciones de la operación, se abre un cuadro de diálogo de configuración de API personalizada con estas configuraciones:

configuración de API personalizada de cs

Nota

Se pueden configurar configuraciones opcionales como parámetros de ruta, parámetros de consultar y encabezados de solicitud en el API Manager (consulte Paso 2: Seleccionar el tipo de servicio y asignar operaciones en API personalizada).

  • Nombre de la API: Introduzca un nombre para la API que se usará para fines de identificación interna. Por defecto, este campo se rellena con el nombre de la operación.

  • Raíz del servicio: El nombre público de la API que se utilizará como parte de la URL del servicio de la API. De forma predeterminada, este campo se rellena con el nombre de la operación convertido a mayúsculas y minúsculas. Este campo no admite espacios ni ciertos caracteres especiales. El uso de caracteres especiales distintos del guion bajo... (_) no se recomienda. Se permiten los siguientes caracteres especiales:

    _ ~ ( ) $ ; / \ ? : @ = & ' ! * @ , + -

  • Descripción: Ingrese una descripción opcional para la API.

  • Configuración adicional: Haga clic para expandir la configuración adicional:

    configuraciones adicionales

    • Ambiente: Este campo se establece en el ambiente del proyecto al que se está accediendo actualmente y no se puede cambiar.

    • Número de versión: Ingrese una versión opcional para usar como parte de la URL del servicio de la API. Este campo permite un máximo de 50 caracteres y no admite espacios ni ciertos caracteres especiales. Se permiten caracteres especiales que no sean un punto. (.)o un guion (-) No se recomienda. Las convenciones de nomenclatura comunes incluyen versiones incrementales, como v1.0, v1.1, v1.2, o usar una fecha en la que se publicó la API, como 2023-09-21.

    • Tiempo de espera: Ingrese el número de segundos antes de que la API expire. El valor predeterminado es 30 segundos. El máximo es 180 segundos.

      Nota

      Esta configuración es independiente de la configuración Tiempo de espera de la operación disponible dentro de la pestaña Opciones de la operación. Las configuraciones de tiempo de espera de operación no se utilizan para las APIs de API Manager a menos que se utilice un agente privado y EnableAPITimeout configuración en el archivo de configuración del agente privado está habilitado.

    • Habilitar el modo de depurar hasta: Seleccione esta opción para habilitar el modo de depurar y permitir la introducción de una fecha y hora para su depurar. El tiempo máximo de activación es de dos semanas. El modo de depuración permite el seguimiento completo de cada solicitud recibida a través de la URL de servicio de la API. Al habilitarse, el sistema conserva el contenido completo de cada solicitud y respuesta de la API hasta 24 horas desde la recepción de la llamada a la API y se aplica a todas las operaciones activadas por la API.

    • Solo SSL: Esta opción está seleccionada de forma predeterminada y requiere el uso de cifrado SSL (recomendado).

    • Habilitar CORS: Seleccione para habilitar Intercambio de recursos entre orígenes (CORS) (no recomendado).

    • Habilitar registro detallado: Seleccione esta opción para habilitar el registro detallado. Los registros detallados de las APIs incluyen datos de solicitud y respuesta en cada registro de API para supervisar los datos entrantes y salientes y facilitar la depuración. Dado que esto puede generar archivos de registro grandes, el registro detallado está deshabilitado por defecto.

  • Nombre del servicio: Introduzca un nombre para el servicio API. Por defecto, este campo contiene el nombre de la operación.

  • Proyecto: El nombre del proyecto al que se está accediendo actualmente.

  • Operación: El nombre de la operación que se expone para el consumo.

  • Método: Seleccione ALL, CUSTOM, DELETE, GET, POST o PUT como método de solicitud para la operación seleccionada. Al seleccionar ALL se crearán solicitudes independientes. DELETE, GET, POST, y PUT métodos de solicitud para la operación (el CUSTOM El método no está incluido).

    Nota

    Servicios API que utilizan una CUSTOM El método no tendrá documentación OpenAPI generada a través del Portal Manager página debido a una limitación de la especificación OpenAPI.

  • Tipo de respuesta: Seleccione entre Objetivo final, Variable del sistema o Sin respuesta:

    • Objetivo final: La respuesta de la API es el objetivo final de la operación. Al seleccionar este tipo de respuesta, la operación debe tener (como objetivo final de la cadena de operación) an Integration Studio Actividad de respuesta de API. Si se utiliza cualquier otro objetivo final, la respuesta de la API estará vacía.

    • Variable del sistema: La respuesta de la API se establece en una variable Jitterbit en la operación. Cuando se selecciona este tipo de respuesta, la operación debe tener (como parte de una cadena de operación) un secuencia de comandos que establezca la variable Jitterbit jitterbit.api.response igual a la respuesta que desea que la API devuelva. Si esta variable no está configurada, la respuesta de la API estará vacía.

    • Sin respuesta: La respuesta de la API está en blanco. Si se acepta la solicitud para ejecutar la operación seleccionada, la API devolverá inmediatamente una respuesta vacía con el código HTTP 202.

  • Roles de usuario: Utilice el menú para seleccionar los roles de la organización cuyos miembros tendrán acceso a la API desde las páginas del API Manager que se muestran a continuación. Los roles disponibles son los definidos en la página Administración de usuarios de la Management Console, que están seleccionados por defecto.

    Esto determina el acceso a esta API específica desde estas páginas:

    Acceso a los Perfiles de Seguridad La página y el acceso para usar la API no se ven afectados por esta selección. (El acceso para usar una API está controlado por perfiles de seguridad).

    Cualquier rol de usuario definido con el permiso Admin siempre tiene acceso completo a todas las APIs y, por lo tanto, no se puede eliminar de la selección. (En la captura de pantalla de ejemplo anterior, el rol Administrador no se puede eliminar por ese motivo).

  • Perfiles de seguridad: Seleccione el método para proporcionar un perfil de seguridad para restringir el acceso para el consumo de la API (opcional):

    • Usar perfil existente: Cuando esté seleccionado, utilice el menú Perfil para seleccionar un perfil de seguridad existente.

    • Crear nuevo perfil: Cuando se selecciona, se encuentran disponibles campos adicionales para configurar un nuevo perfil de seguridad (consulte Configuración del perfil de seguridad):

      crear nuevo perfil

  • Perfil: Visible al seleccionar Usar perfil existente. Utilice el menú para seleccionar un perfil de seguridad existente y restringir el acceso al uso de la API.

  • Publicar: Guarda la API en estado Publicado. La API está activa y disponible en cinco minutos. Una API publicada cuenta como una URL de API para su suscripción a Harmony. Puede acceder a la API publicada desde el API Manager APIs página.

  • Guardar borrador: Guarda la API en estado Borrador y es accesible desde el API Manager APIs página. Un borrador de API no se considera una URL de API para su suscripción a Harmony. Puede acceder y completar la configuración del borrador de API desde el API Manager APIs página.

  • Cancelar: Cierra el cuadro de diálogo sin guardar.

Importante

De forma predeterminada, las operaciones exitosas configuradas para una API personalizada no están incluidos en los registros de operación a menos que una de estas configuraciones esté habilitada:

Las operaciones fallidas se incluyen en los registros de operación independientemente de si las configuraciones anteriores están habilitadas o no.