Página de APIs en Jitterbit API Manager

Introducción

La página APIs es la página de aterrizaje de API Manager y brinda a los administradores de la organización Harmony la capacidad de administrar APIs personalizadas, Servicios OData y APIs de proxy creado a través de API Manager.

Miembros de un rol al que se le ha otorgado acceso de al ambiente Lectura también pueden acceder a la página APIs para las APIs en ese ambiente. Miembros de un rol al que se le ha otorgado acceso Write ambiente tienen acceso de escritura en ese ambiente.

Para acceder a la página APIs, inicie sesión en el portal Harmony, luego use el menú del portal Harmony en la parte superior izquierda para ir a API Manager > APIs:

Asegúrese de acceder a la organización deseada, que se puede cambiar en la barra de navegación superior (consulte Cambiar la organización seleccionada en Portal de la Harmony).

Encabezado de la página de APIs

El encabezado en la parte superior de la página APIs incluye estos controles:

• URL base: La URL de API base de la organización Harmony.

• URLs de API personalizada utilizadas: La cantidad de URLs de API personalizadas utilizadas actualmente del total de URLs de API personalizadas permitidas por la suscripción de la organización. Las URLs de API utilizadas actualmente consisten en aquellas utilizadas por las APIs personalizadas y de OData publicadas y sus clones publicados. Las APIs en borrador no cuentan como URLs de API en uso.

• URLs de proxy de API utilizadas: La cantidad de URLs de API de proxy utilizadas actualmente de la cantidad total de URLs de API de proxy permitidas por la suscripción de la organización. Las URLs de API de proxy utilizadas actualmente consisten en aquellas utilizadas por las APIs de proxy publicadas y sus clones publicados. Las APIs en borrador no cuentan como URLs de API en uso.

• Filtro: Abre un panel con controles para filtrar la tabla por Tipo de API, Estado de API, Grupo de API, Ambiente, Perfil de seguridad y fechas de Última edición y Última publicación:

  

  Los filtros se aplican inmediatamente. Utilice los botones Borrar o Borrar todo para restablecer los filtros y el Botón Cerrar para cerrar el panel.

• Buscar: Ingrese cualquier parte del nombre de la API, la versión, el ambiente, el tipo, la descripción, el estado o la fecha u hora en que se publicó o editó por última vez en el cuadro de búsqueda para filtrar la APIs ( solo caracteres alfanuméricos). La búsqueda no distingue entre mayúsculas y minúsculas.

• Ver: Haga clic en el vista de ficha o vista de lista para alternar el formato utilizado para mostrar las APIs en esta página. La vista de mosaico es la vista predeterminada inicial. La próxima vez que cargue la página APIs, se preseleccionará la última vista seleccionada.

• Importar API: Abre la pantalla de importación de API, donde puedes importar APIs en formato APK (consulta Exportar e importar APIs).

• Exportar API: Abre la pantalla de exportación de API, donde puedes exportar las APIs seleccionadas en formato APK (consulta Exportar e importar APIs).

• Nuevo: Utilice el menú para seleccionar el tipo de API a crear, ya sea API personalizada o proxy de API:

  • API personalizada: (Disponible solo si hay una URL de API personalizada disponible). Abre la pantalla de configuración de API para crear una nueva personalizada o OData API.

  • proxy de API:(Disponible solo si hay una URL de API de proxy disponible). Abre la pantalla de configuración de API de proxy para crear un nuevo proxy API.

Vista en mosaico

Para acceder a la vista de ficha, seleccione el Icono de vista de mosaico.

La vista de mosaicos muestra las APIs como mosaicos. Cada ficha tiene un frente y un reverso que se pueden "dar vuelta" para revelar información y acciones adicionales de la API. El frente se muestra de manera predeterminada. El reverso se muestra al pasar el cursor sobre el ficha:

• Frente: El frente del ficha muestra el nombre de la API, la versión, el ambiente, el tipo de API (Personalizada, OData o Proxy), el estado de la API (Publicada, Publicada con borrador o Borrador) y la última fecha de edición o publicación (en MM/DD/YY formato) en la hora local del navegador. El color del icono a la izquierda del estado de la API indica la categoría del estado de la API:

  Icono	Color	Categoría
  	Verde	La API está publicada.
  	Amarillo	La API se publica con un borrador.
  	Verde abierto	La API es un borrador.

• Parte posterior: La parte posterior del ficha (visible al pasar el cursor sobre ficha) muestra el nombre de la API, el ambiente, la descripción de la API y el nombre del usuario que editó la API por última vez. Además, están disponibles estas acciones:

  • Ver/Editar: Abre la pantalla de configuración de API (vea Configuración de API personalizada, Configuración del servicio OData, o Configuración de proxy de API).

  • Acciones: Haga clic en el Icono del menú de acciones para abrir un menú con estas acciones:

    Elemento del menú API	Descripción
    	Registros de API abre los Registros de API página, que muestra registros de procesamiento y depurar (si el registro de depurar está habilitado) para todas las APIs.
    	Analytics abre Analytics página, que muestra métricas de consumo y rendimiento para todas las APIs.
    	Clonar abre la pantalla de configuración de API (vea Configuración de API personalizada, Configuración del servicio OData, o Configuración de proxy de API), rellenado previamente con los detalles de configuración de la API clonada y valores predeterminados actualizados para estos campos: Nombre de la API: El nombre de la API tiene como prefijo Copia de. Raíz del servicio: La raíz del servicio tiene como prefijo Copia de. ** Versión:** La versión tiene como prefijo -2. Este número no aumenta con clones adicionales.
    	Exportar inicia una descarga de la API a un archivo llamado apis-export.apk Luego, este archivo se puede importar a un ambiente u organización diferente (consulte Exportación e importación de APIs).
    	Eliminar elimina permanentemente la API. Al hacer clic en Eliminar, se muestra un cuadro de diálogo de confirmación para confirmar que desea eliminar permanentemente la API. Precaución Documentación de OpenAPI mostrada en el Portal La página no se actualiza automáticamente cuando se elimina una API. Para actualizar la documentación de OpenAPI, hágalo a través del Administrador del portal página.

  • Copiar URL: Copia la URL de la API a tu portapapeles.

Vista de lista

Para acceder a la vista de lista, seleccione el Icono de Vista de lista.

La vista de lista muestra las APIs en una tabla, con cada columna descrita a continuación. Al hacer clic en una fila de API, se abre el cajón de detalles de API (descrito a continuación).

Las columnas disponibles son los siguientes:

• Nombre de la API: El nombre de la API.

• Versión La versión de la API, tal como se ingresó durante la configuración de la API.

• Tipo: El tipo de API, uno de los siguientes:** API personalizada, **Servicio OData o proxy de API.

• Ambiente: El ambiente donde se almacena la API.

• Estado: El estado de la API, uno de Publicado, Publicado con borrador, o Borrador.

• Última edición: La última fecha guardada (en MM/DD/YYYY formato), hora (en HH:MM:SS formato) y el período de tiempo (AM o PM) en la hora local del navegador.

• Raíz del servicio: El nombre público de la API, tal como se ingresó durante la configuración de la API.

• Grupo: El nombre de cualquier grupo de API la API pertenece a.

• Editado por: El nombre del usuario que guardó la API por última vez.

• Última publicación: La fecha de publicación (en MM/DD/YYYY formato), hora (en HH:MM:SS formato) y el período de tiempo (AM o PM) en la hora local del navegador.

• Publicado por: El nombre del usuario que publicó la API por última vez.

• Puerta de enlace: La puerta de enlace API utilizado por la API.

• Servicios: La cantidad de servicios configurados para la API.

• Acciones: Pase el cursor sobre la fila API para revelar acciones adicionales:

  • Detalles: Abre el cajón de detalles de la API (descrito en la siguiente sección).

  • Copiar URL base de la API: Haga clic para copiar la URL base de la API a su portapapeles.

  • Exportar: Abre el selector de carpetas de su equipo local. Seleccione una carpeta para guardar la exportación de API. Para obtener más información, consulte Exportar e importar APIs.

  • Editar: Abre la página Resumen y confirmación de la API, donde puedes editar la configuración de la API.

  • Más acciones: Abre un menú con estas acciones:

    Elemento del menú API	Descripción
    Clonar	Abre la pantalla de configuración de API (vea Configuración de API personalizada, Configuración del servicio OData, o Configuración de proxy de API), rellenado previamente con los detalles de configuración de la API clonada y valores predeterminados actualizados para estos campos: Nombre de la API: El nombre de la API tiene como prefijo Copia de. Raíz del servicio: La raíz del servicio tiene como prefijo Copia de. ** Versión:** La versión tiene como prefijo -2. Este número no aumenta con clones adicionales.
    Eliminar	Elimina permanentemente la API. Al hacer clic en Eliminar, se muestra un cuadro de diálogo de confirmación para confirmar que desea eliminar permanentemente la API. Precaución Documentación de OpenAPI mostrada en el Portal La página no se actualiza automáticamente cuando se elimina una API. Para actualizar la documentación de OpenAPI, hágalo a través del Administrador del portal página.
    Ver en el portal	(Habilitado solo para APIs personalizadas o proxy con estado Publicado o Publicado con borrador). Abre el Portal página para la API.
    Ver registros	Abre Registros de API página, que muestra registros de procesamiento y depurar (si el registro de depurar está habilitado) para todas las APIs.
    Análisis	Abre Análisis página, que muestra métricas de consumo y rendimiento para todas las APIs.

Cajón de detalles de la API

Para ver los detalles de una API, seleccione una API en la tabla mientras está en vista de lista. Se abre un cajón en la parte inferior de la ventana con cinco pestañas: Perfil, Ajustes, Servicios, Perfiles de seguridad, Roles de usuario (para APIs personalizadas y servicios OData ) y Encabezados de solicitud (para APIs de proxy).

El encabezado del cajón muestra estos detalles y controles:

• Nombre y versión de la API: Muestra el nombre de la API y su versión (si corresponde).
• Anterior / Siguiente: Navega por la lista de APIs de la organización.
• Expandir: Expande el cajón a pantalla completa. Una vez expandido, haga clic en el Minimizar icono para volver a la vista anterior.
• Cerrar: Cierra el cajón.

Pestaña de perfil

La pestaña Perfil muestra información general sobre la API:

• Tipo de API: El tipo de API, uno de los siguientes:** API personalizada, **Servicio OData o proxy de API.

• URL base de la API: La URL base de la API.

• Descripción: (Visible solo para APIs personalizadas y servicios OData). La descripción de la API, tal como se ingresó durante la configuración de la API.

• URL de API existente: (visible solo para APIs de proxy). La URL de la API a proxy.

Pestaña de configuración

La pestaña Configuración proporciona una descripción general de las configuraciones de la API (especificadas durante la configuración de la API ):

Nota

Para editar cualquiera de estas configuraciones, debe hacer clic en Editar en la columna Acción de la API en la tabla.

• Tiempo de espera: 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 Integration 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 está habilitado (predeterminado), los datos se cifran a través de SSL y se aplica HTTPS para todas las solicitudes y respuestas de API (recomendado).

  Cuando está deshabilitada, 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.

• CORS: Cuando está habilitado, el Intercambio de recursos entre orígenes (CORS) se utiliza el mecanismo (no recomendado).

  Advertencia

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

• Habilitar registro detallado: Cuando está habilitado, el registro detallado para 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. Esta configuración está deshabilitada de manera predeterminada, ya que puede crear archivos de registro de gran tamaño.

• Habilitar modo de depuración hasta: Muestra la fecha y la hora en que se deshabilitará el modo de depurar.

Pestaña de servicios

La pestaña Servicios tiene una tabla con una descripción general de los servicios de API:

La tabla se puede ordenar por Nombre del servicio, Método, Ruta, Proyecto, Operación a activar o Tipo de respuesta haciendo clic en la fila de encabezado correspondiente.

• Nombre del servicio: El nombre del servicio API.

• Método: El método de solicitud para el servicio API, uno de GET, POST, PUT, DELETE, ALL o (si el Método está configurado como CUSTOM) el nombre del método personalizado.

• Ruta: La ruta para la solicitud.

• Proyecto: (Visible solo para APIs personalizadas y servicios OData). El nombre del proyecto Integration Studio proyecto.

• Operación a activar: (visible solo para APIs personalizadas y servicios OData). El nombre de la operación que se llama.

• Tipo de respuesta: (visible solo para APIs personalizadas y servicios OData). El tipo de respuesta, uno de los siguientes: Objetivo final, Variable del sistema o Sin respuesta.

• Acciones: Pase el cursor sobre la fila de servicio para revelar acciones adicionales:

  • Copiar URL del servicio API: Copia la URL del servicio API a tu portapapeles.

  • Ir al servicio API: Abre la página Resumen y confirmación de la API, donde puedes editar la configuración de la API.

Pestaña de perfiles de seguridad

La pestaña Perfiles de seguridad proporciona una lista de todos los perfiles de seguridad se utiliza para restringir el acceso para el consumo de la API:

La tabla se puede ordenar por Nombre de perfil, Tipo o Nombre de usuario haciendo clic en la fila de encabezado correspondiente.

• Nombre del perfil: El nombre del perfil de seguridad.

• Tipo: El tipo de autenticación, uno de los siguientes: Anónimo, Clave API, Básico o OAuth 2.0.

• Nombre de usuario: Muestra el nombre de usuario para cualquier perfil de seguridad que utilice autenticación básica. De lo contrario, se muestra el tipo de autenticación.

• Acciones: Pase el cursor sobre la fila del perfil de seguridad para revelar una acción adicional:

  • Ir al perfil de seguridad: Abre la pantalla de configuración para el perfil de seguridad.

Pestaña de roles de usuario

La pestaña Roles de usuario proporciona una lista de los roles de la organización cuyos miembros tienen acceso a la API:

Nota

Esta pestaña solo es visible para APIs personalizadas y servicios OData.

La tabla se puede ordenar por Rol de usuario haciendo clic en la fila de encabezado correspondiente.

• Rol de usuario: El nombre del rol de usuario de Harmony.

• Acciones: Pase el cursor sobre la fila del rol del usuario para revelar una acción adicional:

  • Ir al rol de usuario: Abre la Administración de usuarios de la Consola de administración página.

Pestaña de encabezados de solicitud

La pestaña Encabezados de solicitud proporciona una lista de los encabezados de solicitud de la API del proxy:

Nota

Esta pestaña solo es visible para las APIs de proxy.

La tabla se puede ordenar por Clave o Valor haciendo clic en la fila de encabezado respectiva.

• Clave: La clave del encabezado de la solicitud.

• Valor: El valor del encabezado de la solicitud.

• Anular entrada: Cuando está habilitado, el encabezado de solicitud anula otros encabezados de solicitud que usan la misma Clave.

  Nota

  Para editar esta configuración, debe hacer clic en Editar en la columna Acción de la API en la tabla.

Configuración de la página de vista de lista

Puede ordenar la tabla, reorganizar sus columnas o actualizar su contenido:

• Ordenar: Para ordenar la tabla en orden ascendente, haga clic en cualquier encabezado de columna. Haga clic nuevamente para invertir el orden de clasificación.

• Columnas: Para cambiar la disposición y la visibilidad de las columnas, haga clic en Filtrar columnas. Se abre el cajón Columnas:

  

  El cajón tiene los siguientes controles:

  • Buscar: Ingrese cualquier parte del nombre de la columna en el cuadro de búsqueda para filtrar la lista de columnas (solo caracteres alfanuméricos). La búsqueda no distingue entre mayúsculas y minúsculas.

  • Mostrar todo: hace visibles todas las columnas.

  • Mover: Arrastre y suelte para cambiar la posición de la columna con respecto a otras.

  • Ocultar: La columna está visible. Haz clic para ocultarla.

  • Mostrar: La columna está oculta. Haz clic para mostrarla.

  • Guardar: Guarda las columnas.

  • Cancelar: Cierra el cajón de columnas sin guardar los cambios.