Configuración 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 de API Manager. Para los otros dos tipos ( Servicio OData y proxy de API ), 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 operación.

Requisitos Previos¶

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 desencadena una API Personalizada puede ser 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 operación
  • Despliegue y ejecución de la operación
• Design Studio
  • Creando una operación

Crear una Nueva API Personalizada¶

Cuando accede al API Manager Mis APIs, si no existen APIs personalizadas, servicios OData o APIs de proxy en la organización seleccionada, esta pantalla está 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. Los detalles sobre la configuración de una nueva API Personalizada se proporcionan en Configuración de una 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 utilizada 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 al 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 API: Introduzca un nombre para que la API lo utilice con fines de identificación interna. Se permiten estos caracteres especiales:

  ( ) - _

• Ambiente: El ambiente donde reside la API.

  Nota

  Después de la creación de la API, el ambiente no se puede cambiar. Para mover una API entre ambientes, puede clonar la API o exportar e importar la API en otro ambiente.

• Raíz de servicio: La 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 completa con el Nombre de API convertido a caso camello. Este campo no permite espacios ni ciertos caracteres especiales. Usar caracteres especiales distintos de un guión bajo (_) no es recomendado. Se permiten estos caracteres especiales:

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

• Versión: Ingrese una versión opcional para usar como parte de la URL del servicio API. Este campo permite un máximo de 48 caracteres y no permite espacios ni ciertos caracteres especiales. Usar caracteres especiales distintos de un punto (.) o un guión (-) no es recomendado. Las convenciones de nomenclatura comunes incluyen versiones incrementales, como v1.0, v1.1, v1.2, o utilizando 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 antes de que expire 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. La configuración del tiempo de espera de operación no se utiliza 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: Seleccione requerir el uso de cifrado SSL (recomendado). Sólo SSL está seleccionado de forma predeterminada.

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

  Advertencia

  Habilitar CORS provoca que las operaciones utilicen el OPTIONS Método para ejecutar sin autenticación.

• Habilitar registro detallado: Seleccione 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 valor predeterminado es que el registro detallado está deshabilitado.

• Habilitar modo de depuración hasta: Seleccione para habilitar el modo de depurar y habilitar el ingreso de la 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 del servicio de la API. Cuando está habilitado, el sistema retiene el contenido completo de cada solicitud y respuesta de API durante hasta 24 horas desde el momento en que se recibió la llamada de API y se aplica a todas las operaciones activadas por la API.

  Nota

  Recorrer los datos del evento 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 utilizar el modo de depurar en un ambiente de producción.

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

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

Paso 2: Seleccionar el Tipo de Servicio y Asignar 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 se hace clic, se abre la configuración del servicio API individual (que se describe a continuación). Se pueden agregar múltiples 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: Utilice el menú para seleccionar el método de solicitud para el servicio API, uno de GET, POST, PUT, DELETE, ALL o PERSONALIZADO. Al seleccionar TODOS se crearán GET, PUT, POST, y DELETE métodos para la Operación seleccionada (el CUSTOM método no está incluido). De forma predeterminada, el método de solicitud está configurado en GET.

  Nota

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

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

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

  Nota

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

• Nombre del método personalizado: Visible cuando se selecciona PERSONALIZADO como Método de solicitud. Introduzca el nombre del método que se utilizará, por ejemplo, PATCH. (Solo caracteres alfabéticos, guiones - y guiones bajos _).

• Operación: Dentro de la pestaña Operación, selecciona un proyecto y una operación para asignar al servicio API (requerido 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).

  • Editar proyecto: Cuando se selecciona un proyecto de Cloud Studio, este botón está habilitado. 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 entre en vigor.

  • 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 entre las operaciones implementadas en el proyecto seleccionado.

      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 en Nube:** Para operaciones de API en un Agente en Nube, registro de depurar de operación debe estar habilitado en la operación.
      • ** Agentes Privados:** Para operaciones de API en un Agente Privado, ya sea registro de depurar de 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 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 destino final de la cadena de operación, una Cloud Studio Actividad de respuesta API o Actividad de escritura variable, o un objetivo de respuesta 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 de sistema: La respuesta 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 devuelva la API. 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 los parámetros de solicitud se incluyen en Ruta, esta pestaña se completa con estos campos:

  

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

  • Descripción: Opcionalmente, ingrese una descripción para los parámetros de 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 se hace clic, estos campos estarán disponibles:

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

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

    • Eliminar: Haga clic en el icono de eliminar 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 se hace 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 solicitud debe ser obligatorio para cada solicitud de servicio API.

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

• Duplicar: Haga clic en el icono de duplicar para crear un duplicado del servicio API.

  Nota

  Una vez duplicado 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 icono de eliminar junto a un servicio API para eliminarlo de la API Personalizada.

• Guardar: Haga clic para guardar el servicio API. Cuando se completa la configuración de todos los servicios API, se habilitan 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 para este paso y continuar con el siguiente.

• Guardar cambios: Haga clic para guardar la configuración de este paso y navegar hasta 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 para elegir son aquellos definidos en la página Organizaciones de Management Console (consulte Administración de roles y permisos en Organizaciones).

  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 API
  • Análisis

  Acceso a los Perfiles de seguridad 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 completo a todas las APIs y, por lo tanto, no se puede eliminar de la selección. (En la captura de pantalla de ejemplo que se muestra arriba, la rol Administrador no se puede borrar por ese motivo).

  Nota

  Las APIs creadas antes de Harmony 10.22 tienen todas las funciones de usuario seleccionadas de forma predeterminada para garantizar el acceso continuo a 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. Es posible que sea necesario 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 Nombre de perfil y Tipo según lo configurado 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 Tipo es cualquier otro tipo, la columna Nombre de usuario muestra el mismo valor que Tipo. Para eliminar un perfil asignado, haga clic en el icono de eliminación .
  • 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 para este paso y continuar con el siguiente. Si a la API no se le asigna un perfil de seguridad requerido, esta opción está deshabilitada.

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

• Omitir este paso: Si está presente, haga clic para continuar con el siguiente paso sin almacenar la configuración para este paso. Si a la API no se le asigna 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 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 discapacitado (). Para realizar cambios en esa configuración, haga clic en el icono de edición para volver al Paso 1: Configuración.
  • Habilitar modo de depuración hasta: Esta opción es la misma que se describe 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 tipo de servicio y asignar operaciones con la información correspondiente al tipo de servicio seleccionado. Para realizar cambios, haga clic en el icono de edición para volver al Paso 2: Seleccionar el tipo de servicio y asignar operaciones.

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

• Exportar: Genera e inicia la 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 API, al Nombre de API se le antepone Copia de, a la Raíz de servicio se le antepone Copyof y a la Versión se le agrega -2. La copia de API se abre inmediatamente por sí sola Paso 4: Resumen y confirmación.

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

  Nota

  Si el estado de la API era Publicada o Publicada como borrador en el momento de la eliminación, también se elimina de la cantidad de URL de API utilizadas para su límite de 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 su límite de suscripción no cambia, ya que no se podía acceder a la API mientras estaba en estado Borrador.

• Guardar como borrador: Guarda la API en estado Borrador o Publicado con estado 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 cuentan para el límite de suscripción de API URL.

• Publicado con borrador: Se utiliza una API cuyo estado era Publicado en el momento en que se utiliza Guardar como borrador. Una API que se publica con un borrador cuenta en el límite de suscripción de API URL, ya que se puede acceder a la API aunque no se pueda acceder al borrador.

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

  

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

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