Publicar una operación como API¶

Introducción¶

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

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

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

• Las Mis APIs página del API Manager.
• La pestaña Recursos del panel del proyecto para el Integration Studio proyecto 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:

• La organización a la que se accede debe tener una suscripción a API Manager y tener los permisos de rol adecuados) y niveles de acceso al ambiente. Para obtener información sobre cómo agregar API Manager a su licencia, comuníquese con su Administrador de éxito del cliente (CSM).

• La operación no debe tener ningún cambio no implementado.

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:

• Nombre de API: Ingrese un nombre para que la API lo use con fines de identificación interna. De manera predeterminada, este campo se completa 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 manera predeterminada, este campo se completa con el nombre de la operación convertido a mayúsculas y minúsculas. Este campo no permite espacios ni determinados caracteres especiales. El uso de caracteres especiales distintos del guión bajo (_) No se recomienda. Se permiten estos caracteres especiales:

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

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

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

  • 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 determinados caracteres especiales. El uso de caracteres especiales distintos del punto (.) o un guión (-) no se recomienda. Las convenciones de nombres 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 la cantidad de segundos antes de que se agote el tiempo de espera de la API. 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 habilitar la entrada de una fecha y hora correspondientes en las que se deshabilitará el modo de depurar. La duración máxima de la habilitación es de dos semanas. El modo de depuración habilita el seguimiento completo de cada solicitud recibida a través de la URL del servicio de la API. Cuando está habilitado, el sistema conserva el contenido completo de cada solicitud y respuesta de la API durante hasta 24 horas desde el momento en que se recibió 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 para habilitar el registro detallado. Los registros detallados para las APIs incluyen datos de solicitud y respuesta en cada registro de API para ayudar a monitorear los datos entrantes y salientes y facilitar la depuración. Como esto puede generar archivos de registro grandes, el registro detallado está deshabilitado de manera predeterminada.

• Nombre del servicio: Ingrese un nombre para el servicio API. De manera predeterminada, este campo está configurado con 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 uno de los siguientes: ALL, CUSTOM, DELETE, GET, POST o PUT como el método de solicitud que se utilizará para la operación seleccionada. Si selecciona ALL, se crearán 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 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. Cuando se selecciona 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á una respuesta vacía inmediata con el código HTTP 202.

• Roles de usuario: Seleccione los roles de la organización cuyos miembros tendrán acceso a la API desde las páginas del API Manager que se enumeran a continuación. Los roles que puede elegir son los definidos en la página Administración de usuarios de la Management Console.

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

  • Mis APIs
  • Administrador del portal, incluida la generación de documentación API
  • Portal
  • Registros de API
  • Análisis

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

  Cualquier rol de usuario definido con el permiso Admin siempre tiene acceso total a todas las APIs y, por lo tanto, no se puede borrar de la selección. (En la captura de pantalla de ejemplo que se muestra arriba, el rol Administrator no se puede borrar por ese motivo).

• Perfil: Opcionalmente, utilice el menú para seleccionar un perfil de seguridad existente para restringir el acceso para el consumo de la API.

  Nota

  Si no hay perfiles de seguridad configurados para el ambiente al que se accede actualmente, puede configurar uno en API Manager. Para obtener instrucciones, consulte Configuración del perfil de seguridad.

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

• Guardar borrador: Guarda la API en estado Borrador y se puede acceder a ella desde el API Manager Mis APIs página. Un borrador de API no cuenta como una URL de API en su asignación de suscripción a Harmony. Puede acceder y completar la configuración del borrador de API desde el API Manager Mis APIs página.

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