Saltar al contenido

Exportar e importar APIs en Jitterbit API Manager

Introducción

Desde las APIs página, puede exportar o importar una sola API personalizada, servicio OData o API de proxy, o un grupo de APIs:

  • Exportar: Le permite exportar una sola API o un grupo de APIs a un archivo APK.
  • Importar: Le permite importar una sola API o un grupo de APIs usando un archivo APK que se exportó previamente en API Manager.

Juntas, las funcionalidades de exportación e importación le permiten migrar APIs a otros ambientes u organizaciones según sea necesario.

Nota

Los proyectos, operaciones y entidades de soporte deben existir en el ambiente de destino para que las APIs funcionen correctamente.

APIs de exportación

Al exportar APIs, puedes exportar una API única o un grupo de APIs.

Exportar una sola API

Puede exportar una única API personalizada, un servicio OData o una API proxy desde estas ubicaciones:

  • En la vista de ficha en las APIs página, pase el cursor sobre el ficha API, haga clic en el Icono del menú de acciones y seleccione Exportar:

    exportación de vista de tarjeta

  • En la vista de lista en las APIs, pase el cursor sobre la fila API y haga clic en el icono Icono del menú de acciones en la columna Acciones y seleccione Exportar:

    exportación de vista de lista

  • Durante la configuración de la API, haga clic en Exportar al final del paso 4:

    Exportación de configuración de API de API Manager

Al seleccionar Exportar se inicia una descarga de la API a un archivo llamado apis-export.apk.

Exportar un grupo de APIs

Para exportar un grupo de APIs, haga clic en Exportar API en APIs página:

API de exportación del grupo de encabezado de APIs

Después de hacer clic en Exportar API, se abre la pantalla Exportar API:

APIs de selección de exportación de grupo

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

  • Seleccionar APIs: Una vez seleccionado un ambiente, se completa una lista de todas las APIs dentro de ese ambiente:

    • Seleccionar: Seleccione las APIs que desea exportar. La casilla de verificación en la columna del encabezado permite agregar todas las APIs a la vez.

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

      Icono Color Categoría
      adjunto Verde La API está publicada.
      adjunto Amarillo La API se publica con un borrador.
      adjunto Abierto Verde 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, ya sea personalizada (CUSTOM API), OData (ODATA), o proxy (API PROXY).

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

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

APIs de importación

Al importar APIs, puede seleccionar una o más APIs de una base de datos exportada Archivo APK que se importará a otro ambiente.

Para importar APIs, haga clic en Importar API en APIs página:

API de importación de encabezado de APIs

Después de hacer clic en Importar API, siga estos pasos para importar las APIs:

Paso 1: Seleccionar las APIs y el ambiente

APIs de importación

  • Archivo API: Haga clic en Explorar para buscar un archivo APK que se haya exportado previamente desde API Manager.

  • Ambiente: Utilice el menú para seleccionar el ambiente al que desea importar las APIs. 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.

  • Seleccione la(s) API a importar: Seleccione las APIs que se importarán al ambiente seleccionado).

    • Seleccionar: Seleccione las APIs que desea importar. La casilla de verificación en la columna del encabezado permite seleccionar todas las APIs a la vez.

    • API: El nombre de la API.

      Nota

      Un El icono de error se muestra junto al nombre de la API cuando la combinación de Nombre público de la API y Versión ya existe en el ambiente de destino. Si se selecciona una API con un error para importar, el botón Siguiente se desactiva. Para solucionarlo, edite uno o ambos valores en la configuración adicional (descrita a continuación).

    • Nombre público de la API: La raíz del servicio de la URL del servicio de la API.

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

    • Tipo: El tipo de API, una personalizada (CUSTOM API), OData (ODATA), o proxy (API PROXY).

    • Configuración adicional: Haz clic en el triángulo desplegable Para ver configuraciones adicionales para la API:

      configuraciones adicionales

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

      • Nombre público de la API: Muestra la Raíz del servicio actual de la URL del servicio API utilice el cuadro de texto para cambiar la Raíz del Servicio que se usará para la API. Se permiten los siguientes caracteres especiales:

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

      • Versión: Muestra la versión actual de la API. Utilice el cuadro de texto para cambiar la versión de la API.

      • Asignar roles a usuarios: Seleccione los roles de la organización cuyos miembros tendrán acceso a la API desde las páginas del API Manager que se muestran a continuación. Los roles disponibles son los definidos en la pestaña Roles de la página Administración de usuarios.

        Esta configuración determina el acceso a esta API específica desde estas páginas:

        Acceso a los Perfiles de Seguridad La página y el acceso para usar la API no se ven afectados por esta selección. (El acceso para usar 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 anterior, el rol Administrador no se puede eliminar por ese motivo).

      • Asignar perfil de seguridad: Opcionalmente, utilice el menú para seleccionar un perfil de seguridad existente que se usará para restringir el acceso al uso de la API. Puede escribir cualquier parte del nombre del perfil de seguridad en el menú para filtrar la lista de perfiles. Los resultados del menú se filtran en tiempo real con cada pulsación de tecla. Si no se selecciona ningún perfil de seguridad, se utiliza la autenticación anónima. Es posible que se requiera asignar un perfil de seguridad para guardar la API, según las políticas de la organización de Harmony.

        Nota

        Al importar una API, solo se le puede asignar un único API de seguridad. Una vez API, puede API para asignar perfiles de seguridad adicionales.

  • Siguiente: Una vez que se selecciona una API para importar, haga clic en el botón Botón siguiente para pasar a la siguiente pantalla.

  • Cancelar: Haga clic para regresar a APIs página.

  • Importar: Este botón está deshabilitado hasta el Paso 2: Seleccionar las APIs que se publicarán está completo.

Paso 2: Seleccionar las APIs que se publicarán

URLs de APIs de importación utilizadas

Archivo API: Este campo está deshabilitado en este paso de la configuración. Para realizar cambios, vuelva al paso 1 de la configuración.

  • Ambiente: Este campo está deshabilitado en este paso de la configuración. Para realizar cambios, vuelva al paso 1 de la configuración.

  • Seleccionar APIs para publicar: Se muestran las APIs previamente seleccionadas para ser importadas:

    • Seleccionar: Opcionalmente, seleccione las APIs que se publicarán al importar. Las APIs no seleccionadas se guardan como APIs. La casilla de verificación en la columna de encabezado permite seleccionar todas las APIs a la vez. A medida que se seleccionan las APIs, los valores en URLs utilizadas se actualizan según corresponda.

    • Nombre público 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, una personalizada (CUSTOM API), OData (ODATA), o proxy (API PROXY).

  • URLs utilizadas: La cantidad de URLs de API publicadas que se contabilizarán en su asignación de suscripción de Harmony una vez que se complete la importación.

    • API: Refleja la cantidad de URLs de API que estarán en uso (después de completar la importación) del total de URLs de API permitidas por la suscripción de la organización. Las URLs de API utilizadas actualmente son las utilizadas por las APIs personalizadas y de servicio OData publicadas, y sus clones publicados. Las APIs en borrador no se consideran URLs de API en uso.

    • Proxy: Refleja la cantidad de URLs de API proxy que estarán en uso (después de completar la importación) del total de URLs de API proxy permitidas por la suscripción de la organización. Las URLs de API proxy utilizadas actualmente son las utilizadas por las APIs proxy publicadas y sus clones publicados. Los borradores de APIs no se consideran URLs de API proxy en uso.

  • Atrás: Haga clic en el Botón de retroceso para volver al paso 1 de la configuración.

  • Cancelar: Haga clic para regresar a APIs página.

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

Al hacer clic en Importar, un mensaje indica si las APIs se importaron correctamente. Si se realizó correctamente, las APIs seleccionadas para su publicación se publicarán en el nuevo ambiente y estarán disponibles de inmediato. Las APIs que no se publicaron se guardarán en el nuevo ambiente como borradores. Los borradores de APIs no estarán disponibles en el nuevo ambiente hasta que se publiquen individualmente.

  • Descartar: Haga clic para regresar a las APIs página.