Exportar e importar APIs en Jitterbit API Manager

Introducción

Desde la página de APIs, se pueden exportar o importar APIs para migrarlas a otros entornos u organizaciones según sea necesario. Se puede trabajar con una sola API personalizada, API OData o API proxy, o con un grupo de APIs.

Exportar APIs

Se pueden exportar APIs individualmente o en grupos para migrarlas a otros entornos u organizaciones.

Exportar una sola API

Elija el método de exportación según su vista actual:

• Vista de lista: Pase el cursor sobre la columna de Acciones de la API y haga clic en Exportar.
• Vista de mosaico: Haga clic en el menú de acciones y seleccione Exportar.

Seleccionar Exportar descarga la API en un archivo llamado apis-export.apk.

Exportar múltiples APIs

Para exportar múltiples APIs, haga clic en Exportar desde la página de APIs para abrir la pantalla de configuración.

Configure los siguientes ajustes para exportar un grupo de APIs:

• Seleccionar entorno: Use el menú para seleccionar el entorno de las APIs que se van a exportar. Puede escribir cualquier parte del nombre del entorno en el menú para filtrar la lista de entornos. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla.

• Seleccionar APIs: Después de seleccionar un entorno, se muestra una lista de todas las APIs dentro de ese entorno.

  • Seleccionar: Seleccione las APIs a exportar. Use la casilla de verificación en la columna del encabezado para agregar todas las APIs a la vez.

  • API: Muestra el nombre de la API. El color del ícono a la izquierda del nombre de la API indica la categoría del estado de la API:

    Ícono	Color	Categoría
    	Verde	La API está publicada.
    	Amarillo	La API está publicada con un borrador.
    	Verde Abierto	La API es un borrador.

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

  • Tipo de API: Muestra el tipo de API (personalizada, OData o proxy).

• Exportar: Haga clic para iniciar la descarga de las APIs seleccionadas a un archivo APK llamado apis-export.apk. Un diálogo indica si la exportación fue exitosa y muestra una lista de las APIs exportadas con éxito.

• Cancelar: Haga clic para cancelar la exportación y regresar a la página de APIs.

Importar APIs

Para importar APIs, haga clic en Importar desde la página de APIs.

Paso 1: Seleccionar y configurar APIs

En este paso, selecciona el archivo APK, elige el entorno de destino y configura las APIs que se van a importar.

• Archivo de API: Haga clic en Examinar para buscar un archivo APK que haya exportado previamente desde el Administrador de API.

• Entorno: Utilice el menú para seleccionar el entorno en el que desea importar las APIs. Puede escribir cualquier parte del nombre del entorno en el menú para filtrar la lista de entornos. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla.

Seleccionar y configurar APIs para importar

Después de seleccionar un archivo APK, seleccione las APIs que se importarán al entorno seleccionado.

• Seleccionar: Seleccione las APIs para importar. Utilice la casilla de verificación en la columna de encabezado para seleccionar todas las APIs a la vez.

• API: Muestra el nombre de la API.

  Nota

  Un ícono de error aparece junto al nombre de la API cuando la combinación de Nombre Público de API y Versión ya existe en el entorno de destino. Si selecciona una API con un error para importar, el botón Siguiente está deshabilitado. Para resolver el error, edite uno o ambos de esos valores en la configuración adicional (descrito a continuación).

• Nombre Público de la API: Muestra la Raíz del Servicio de la URL del servicio API.

• Versión: Muestra la versión de la API.

• Tipo: Muestra el tipo de API (personalizada, OData o proxy).

Configurar ajustes adicionales

Haz clic en la flecha para ver y configurar ajustes adicionales para cada API.

• Nombre de la API: Muestra el nombre actual de la API. Usa el cuadro de texto para cambiar el nombre de la API.

• Nombre Público de la API: Muestra la actual Raíz del Servicio de la URL del servicio API. Usa el cuadro de texto para cambiar la Raíz del Servicio que se utilizará para la API. Se permiten los siguientes caracteres especiales: . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -

• Versión: Muestra la versión actual de la API. Usa el cuadro de texto para cambiar la versión que se utilizará para la API.

• Asignar Perfil de Seguridad: Opcionalmente, usa el menú para seleccionar un perfil de seguridad existente que se utilizará para restringir el acceso al consumo de la API. Puedes 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. Si no se selecciona un perfil de seguridad, se utiliza la autenticación anónima. Dependiendo de las políticas de la organización Harmony, es posible que necesites asignar un perfil de seguridad para guardar la API.

  Nota

  Al importar una API, solo puedes asignar un único perfil de seguridad a esa API. Después de importar la API, puedes editar la API para asignar perfiles de seguridad adicionales.

  • Crear Nuevo Perfil: Haz clic para abrir la pantalla de configuración del perfil de seguridad. Después de crear el nuevo perfil, estará disponible en el menú Asignar Perfil de Seguridad.

• Siguiente: Después de seleccionar una API para importar, haz clic en el botón siguiente para pasar a la siguiente pantalla.

• Cancelar: Haz clic para regresar a la página de APIs.

• Importar: Este botón está deshabilitado hasta que completes el paso 2.

Paso 2: Seleccionar APIs para publicar

En este paso, eliges qué APIs publicar inmediatamente y revisas el conteo de URLs que se utilizarán después de completar la importación.

• Seleccionar: Opcionalmente, selecciona las APIs que se publicarán al ser importadas. API Manager guarda las APIs no seleccionadas como APIs en borrador. Usa la casilla de verificación en la columna del encabezado para seleccionar todas las APIs a la vez. A medida que seleccionas APIs, los valores bajo URLs utilizadas se actualizan en consecuencia.

• Nombre Público de API: Muestra el nombre de la API.

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

• Tipo: Muestra el tipo de API (personalizada, OData o proxy).

• URLs utilizadas: Muestra el número de URLs de API publicadas que se contarán contra tu límite de suscripción de Harmony después de completar la importación.

• API: Refleja el número de URLs de API que estarán en uso (después de completar la importación) de un total de URLs de API permitidas por la suscripción de la organización. Las URLs de API actualmente utilizadas consisten en aquellas utilizadas por APIs personalizadas y OData publicadas y sus clones publicados. Las APIs en borrador no cuentan como URLs de API en uso.

• Proxy: Refleja el número de URLs de API proxy que estarán en uso (después de completar la importación) de un total de URLs de API proxy permitidas por la suscripción de la organización. Las URLs de API proxy actualmente utilizadas consisten en aquellas utilizadas por APIs proxy publicadas y sus clones publicados. Las APIs en borrador no cuentan como URLs de API proxy en uso.

• Atrás: Haz clic en el botón de atrás para regresar al paso 1.

• Cancelar: Haz clic para regresar a la página de APIs.

• Importar: Haz clic para importar las APIs seleccionadas. Los proyectos, operaciones y entidades de soporte deben existir en el entorno de destino para que las APIs funcionen correctamente.

  Cuando haces clic en Importar, un mensaje indica si las APIs se importaron con éxito. Si es exitoso, API Manager publica las APIs seleccionadas en el nuevo entorno, haciéndolas accesibles de inmediato. API Manager guarda las APIs que no seleccionaste para publicar como borradores en el nuevo entorno. Estas APIs borrador no son accesibles en el nuevo entorno hasta que las publiques individualmente.

• Descartar: Haz clic para regresar a la página de APIs.