Configuración de API Personalizada

Introducción

Esta página describe cómo crear y configurar una API personalizada desde Mis APIs página de Harmony API Manager. Las APIs personalizadas son uno de los tres tipos de APIs configurado a través del API Manager. Para los otros dos tipos (servicio OData y API de proxy), consulte Configuración del servicio OData y Configuración de proxy de API.

Alternativamente, se pueden crear APIs personalizadas en Cloud Studio usando Publicar como API opción a la que se accede desde un menú de acciones de la operación.

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 proyecto de Cloud Studio asociado con la API personalizada.

Prerrequisitos

Como una API personalizada expone una operación de Harmony para su consumo, dicha operación primero debe crearse e desplegarse en Harmony. Luego, se hace referencia a la operación existente durante la configuración de la API personalizada. La operación que activa una API personalizada puede ser una Cloud Studio o Design Studio operación.

Para obtener instrucciones sobre cómo crear e desplegar una operación, consulte estos recursos:

• Cloud Studio
  • Creación y configuración de operaciones
  • Despliegue y ejecución de la operación
• Design Studio
  • Creando una operación

Crear una Nueva API Personalizada

Cuando accedes al API Manager Mis APIs página, si no existen APIs personalizadas, servicios OData o APIs de proxy en la organización seleccionada, esta pantalla estará en blanco.

Para crear una nueva API personalizada, haga clic en Nueva API:

Al hacer clic en Nueva API, se abre la pantalla de configuración de API personalizada. En Configurar una API personalizada se proporcionan detalles sobre cómo configurar una nueva API personalizada abajo.

Configurar una API Personalizada

La pantalla de configuración incluye cuatro pasos de configuración, cada uno de los cuales se describe a continuación:

• Paso 1: Configuración
• Paso 2: Seleccionar el tipo de servicio y asignar operaciones
• Paso 3: Asignar roles de usuario y perfiles de seguridad
• Paso 4: Resumen y confirmación

La URL de servicio de una API es la URL que se utiliza para consumir la API mediante un método de autenticación configurado. Las partes de la URL de servicio de una API se describen en Introducción a API Manager en URL del servicio API.

La URL del servicio se muestra en la parte superior de cada paso después de completar el paso 1:

Paso 1: Configuración

• Nombre de la API: Ingrese un nombre para que la API lo use con fines de identificación interna. Se permiten los siguientes caracteres especiales:

  ( ) - _

• Ambiente: Utilice el menú para seleccionar el ambiente en el que residirá la API. Puede escribir cualquier parte del nombre del ambiente en el menú para filtrar la lista de ambientes. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla.

  Nota

  Después de crear la API, no se puede cambiar el ambiente. Para mover una API entre ambientes, puedes API o exportarla e importarla la API en otro ambiente.

• Raíz del servicio: El nombre público de la API que se usará como parte de la URL del servicio de la API. De manera predeterminada, este campo se completa con el nombre de la API convertido a camel case. 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:

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

• 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 48 caracteres y no permite espacios ni ciertos caracteres especiales. El uso de caracteres especiales distintos de un 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 2021-08-28.

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

• Tiempo de espera: Ingrese la cantidad de segundos que deben transcurrir 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 del tiempo de espera de operación en Cloud Studio o Design Studio. Los ajustes de tiempo de espera de operación no se utilizan a menos que un agente privado se utiliza y el EnableAPITimeout configuración en el archivo de configuración del agente privado está habilitado.

• Solo SSL: Cuando se selecciona (predeterminado), los datos se cifran a través de SSL y se aplica HTTPS para todas las solicitudes y respuestas de API (recomendado).

  Si no se selecciona esta opción, los datos que se transmiten a través de solicitudes y respuestas de API no se cifran y otros pueden interceptarlos y verlos, lo que podría exponer información confidencial.

• Habilitar CORS: Seleccione para habilitar Intercambio de recursos entre orígenes (CORS) (no recomendado). Habilitar CORS está seleccionado de manera predeterminada.

  Advertencia

  Habilitar CORS provoca operaciones que utilizan el OPTIONS método para ejecutar sin autenticación.

• Habilitar registro detallado: Seleccione esta opción para habilitar el registro detallado. El registro detallado para las APIs incluye 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 crear archivos de registro grandes, el registro detallado está deshabilitado de manera predeterminada.

• Habilitar modo de depuración hasta: Seleccione esta opción para habilitar el modo de depurar y permitir la introducción 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 permite el seguimiento completo de cada solicitud recibida a través de la URL de 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.

  Nota

  Recorrer los datos de eventos puede resultar difícil con grandes volúmenes (pruebas de carga, pruebas de preproducción, etc.). El aumento de los datos retenidos puede generar problemas de seguridad y espacio de almacenamiento. No recomendamos usar el modo de depurar en un ambiente de producción.

• Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso.

• Guardar cambios: Haga clic para guardar la configuración de este paso y navegar al Paso 4: Resumen y confirmación.

Paso 2: Seleccione el Tipo de Servicio y Asigne Operaciones

• Tipo de servicio: Seleccione API Personalizada.

• Agregar servicio API: Haga clic para agregar un servicio API para exponer una operación de Harmony para su consumo. Una vez que haga clic, se abrirá la configuración del servicio API individual (descrita a continuación). Se pueden agregar varios servicios API a una API personalizada.

Después de hacer clic en Agregar servicio API, se abre la configuración de un servicio API:

• Método de solicitud: Use el menú para seleccionar el método de solicitud para el servicio API, uno de GET, POST, PUT, DELETE, ALL o CUSTOM. Si selecciona ALL, se crearán solicitudes independientes. GET, PUT, POST, y DELETE métodos para la Operación seleccionada (la CUSTOM el método no está incluido). De manera predeterminada, el método de solicitud se establece en GET.

  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.

• Nombre del servicio: Ingrese un nombre para el servicio API.

• Ruta: Opcionalmente, ingrese una ruta para la solicitud. La ruta debe comenzar con una barra diagonal / y debe tener todos los parámetros de la solicitud entre llaves { }No se permiten otros caracteres especiales.

  Nota

  La combinación del método de solicitud y Ruta debe ser única para cada servicio de API en la API personalizada.

• Nombre del método personalizado: Visible cuando se selecciona CUSTOM como método de solicitud. Ingrese el nombre del método que se utilizará, por ejemplo, PATCH. (Caracteres alfabéticos, guiones) -, y subraya _ solo.)

• Operación: Dentro de la pestaña Operación, selecciona un proyecto y una operación para asignar al servicio API (necesario para habilitar el botón Guardar):

  • Asignar proyecto: Utilice el menú para seleccionar un proyecto implementado desde el ambiente donde se está configurando la API (especificado en Paso 1: Configuración). Puede escribir cualquier parte del nombre del proyecto en el menú para filtrar la lista de proyectos. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla.

  • Editar proyecto: Cuando se selecciona un proyecto de Cloud Studio, este botón se habilita. Al hacer clic en Editar proyecto, se abre el proyecto en Cloud Studio en una nueva pestaña.

    Nota

    Debe desplegar cualquier cambio realizado en el proyecto para que surta efecto.

  • Asignar operación(es): Utilice los menús para seleccionar una Operación y un Tipo de respuesta para el servicio API:

    • Operación: Seleccione una de las operaciones implementadas en el proyecto seleccionado. Puede escribir cualquier parte del nombre de la operación en el menú para filtrar la lista de operaciones implementadas. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla.

      Importante

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

      • Agentes de la nube: Para las operaciones de API en un agente de la nube, registro de depurar de operación debe estar habilitado en la operación.
      • Agentes privados: Para las operaciones de API en un agente privado, registro de depurar de la operación debe estar habilitado en la operación o debe configurar EnableLogging=true en el [APIOperation] sección del archivo de configuración del agente privado.

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

    • Tipo de respuesta: Seleccione uno de los siguientes: Objetivo final, Variable del sistema o Sin respuesta:

      • Objetivo final: La respuesta de la API es el objetivo final de la cadena de operación. Cuando se selecciona este tipo de respuesta, la operación seleccionada debe tener, como objetivo final de la cadena de operación, una actividad de respuesta de API de Cloud Studio o Actividad de escritura variable, o un objetivo de respuesta de API de Design Studio o objetivo de variable global. 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 cadena de operación. Cuando se selecciona este tipo de respuesta, la operación seleccionada debe tener, como parte de la 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.

• Parámetros de ruta: Cuando se incluyen parámetros de solicitud en la Ruta, esta pestaña se completa con estos campos:

  

  • Parámetro: Muestra los parámetros de solicitud definidos en la Ruta.

  • Descripción: Opcionalmente, ingrese una descripción para los parámetros de la solicitud.

• Parámetros de consulta: Esta pestaña le permite agregar cualquier parámetro de consultar al servicio API:

  

  • Agregar parámetro: Haga clic para agregar un parámetro de consultar al servicio API. Una vez que haga clic, estos campos estarán disponibles:

    • Parámetro: Ingrese el nombre del parámetro de consultar.

    • Descripción: Opcionalmente, ingrese la descripción del parámetro de consultar.

    • Eliminar: Haga clic en el eliminar icono junto a un parámetro de consultar para eliminar ese parámetro.

• Encabezados: Esta pestaña le permite agregar cualquier encabezado de solicitud al servicio API:

  

  • Agregar parámetro: Haga clic para agregar un encabezado de solicitud al servicio API. Una vez que haga clic, estos campos estarán disponibles:

    • Parámetro: Ingrese el nombre del encabezado de la solicitud.

    • Descripción: Opcionalmente, ingrese la descripción del encabezado de la solicitud.

    • Obligatorio: Seleccione si el encabezado de la solicitud debe ser obligatorio para cada solicitud de servicio de API.

    • Eliminar: Haga clic en el eliminar icono junto a un encabezado de solicitud para eliminar ese encabezado.

• Duplicado: Haga clic en el ícono duplicado para crear un duplicado del servicio API.

  Nota

  Una vez que se duplica el servicio API, debe cambiar el método de solicitud o la Ruta, ya que cada servicio API debe tener una combinación única de esos campos.

• Eliminar: Haga clic en el eliminar icono junto a un servicio API para eliminarlo de la API personalizada.

• Guardar: Haga clic para guardar el servicio API. Cuando se complete la configuración de todos los servicios API, se habilitarán los botones Siguiente y Guardar cambios. Una configuración de servicio API incompleta se indica con un icono de error junto al nombre del servicio API:

  

  Para resolver y habilitar los botones Siguiente y Guardar cambios, complete la configuración o elimine el servicio API.

• Cancelar: Haga clic para cancelar la configuración del servicio API.

• Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso.

• Guardar cambios: Haga clic para guardar la configuración de este paso y navegar al Paso 4: Resumen y confirmación.

Paso 3: Asignar Roles de Usuario y Perfiles de Seguridad

• Asignar 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 se pueden elegir son los definidos en la pestaña Roles de la página Administración de usuarios.

  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).

  Nota

  Las APIs creadas antes de Harmony 10.22 tienen todos los roles de usuario seleccionados de forma predeterminada para garantizar el acceso continuo para todos los usuarios.

• Asignar perfil(es) de seguridad: Utilice el menú desplegable para seleccionar un perfil de seguridad existente que se utilizará para restringir el acceso para el consumo de la API. Puede escribir cualquier parte del nombre del perfil de seguridad en el menú para filtrar la lista de perfiles de seguridad. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla. Es posible que se requiera asignar un perfil de seguridad para guardar la API, según las políticas de la organización Harmony.

  • Asignar perfil: Haga clic para asignar un perfil de seguridad seleccionado a la API. Los perfiles de seguridad asignados se enumeran en la tabla con el Nombre de perfil y el Tipo tal como se configuraron para el perfil de seguridad en Configuración del perfil de seguridad. Si el Tipo es Básico, la columna Nombre de usuario muestra el Nombre de usuario proporcionado durante la configuración. Si el Tipo es cualquier otro tipo, la columna Nombre de usuario muestra el mismo valor que el Tipo. Para eliminar un perfil asignado, haga clic en el botón eliminar icono.
  • Crear nuevo perfil: Haga clic para crear un nuevo perfil de seguridad. Para obtener instrucciones, consulte Configuración del perfil de seguridad.

• Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente. Si no se le asigna a la API un perfil de seguridad requerido, esta opción estará deshabilitada.

• Guardar cambios: Si está habilitada, haga clic para guardar la configuración de este paso. Si no se le asigna a la API un perfil de seguridad requerido, esta opción estará deshabilitada.

• Omitir este paso: Si está presente, haga clic para continuar con el siguiente paso sin almacenar la configuración de este paso. Si no se le asigna a la API un perfil de seguridad requerido, esta opción no está presente.

Paso 4: Resumen y Confirmación

• Nombre de API y Ambiente: El nombre de la API seguido del ambiente entre paréntesis, tal como se configuró en Paso 1: Configuración.

  • Descripción, Tiempo de espera, Solo SSL, CORS habilitado y Registro detallado habilitado: La descripción de la API y otras configuraciones que están habilitadas () o discapacitados (). Para realizar cambios en esas configuraciones, haga clic en el botón editar icono para volver a Paso 1: Configuración.
  • Habilitar modo de depuración hasta: Esta opción es la misma que la descrita en Paso 1: Configuración. Puede cambiar esta configuración directamente desde este paso en lugar de tener que volver al primer paso.

• Operaciones: Las operaciones asignadas en Paso 2: Seleccionar el tipo de servicio y asignar operaciones con la información correspondiente al tipo de servicio seleccionado. Para realizar cambios, haga clic en el botón editar icono para volver a Paso 2: Seleccionar tipo de servicio y asignar operaciones.

• Roles de usuario y Perfiles de seguridad: Los roles y perfiles de seguridad asignados en el Paso 3: Asignar roles de usuario y perfiles de seguridad. Para realizar cambios, haga clic en el editar icono para volver a Paso 3: Asignar roles de usuario y perfiles de seguridad.

• Exportar: Genera e inicia una descarga de un archivo APK (apis-export.apk) que contiene una exportación de la API (consulte Exportación e importación de APIs).

• Clonar: Crea una copia de una API existente. En la copia de la API, el nombre de la API se antepone con Copia de, la raíz del servicio se antepone con Copia de y la versión se anexa con -2. La copia de la API se abre inmediatamente en su propio Paso 4: Resumen y confirmación.

• Eliminar: Elimina permanentemente la API y cierra la configuración. Aparecerá un cuadro de diálogo que le solicitará que confirme que desea eliminar la API.

  Nota

  Si el estado de la API era Publicado o Publicado con Borrador en el momento de la eliminación, también se elimina de la cantidad de URL de API utilizadas para el límite de su suscripción. Si el estado de la API era Borrador en el momento de la eliminación, la cantidad de URL de API utilizadas para el límite de su suscripción no cambia, ya que la API no era accesible mientras estaba en estado Borrador.

• Guardar como borrador: Guarda la API en estado Borrador o en estado Publicado con borrador:

• Borrador: Una API nueva o una API cuyo estado era Borrador en el momento en que se utilizó Guardar como borrador. Los borradores no se tienen en cuenta para el límite de suscripción de API URL.

• Publicado con borrador: Una API cuyo estado era Publicado en el momento en que se usa Guardar como borrador. Una API que se publica con un borrador se tiene en cuenta para el límite de suscripción de URL de API, ya que la API es accesible aunque su borrador no lo sea.

• Guardar y publicar: Guarda la API en estado Publicado. La API está activa y accesible en cinco minutos. Una API publicada cuenta para el límite de suscripción de API URL, ya que la API está accesible. Un cuadro de diálogo indica que la API está activa:

  

• Copiar URL: Copia la URL del servicio de la API (vea URL del servicio de la API).

• Generar documento OpenAPI: Abre el Administrador del portal página, donde puede generar documentación API para el Portal página.
• Descartar: Cierra el diálogo.