APIs de Exportación e Importación

Introducción

Desde Mis APIs página, puede exportar o importar una única 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.

APIs de Exportación

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

Exportar una Única API

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

• En la vista de ficha en Mis APIs, pase el cursor sobre el ficha API y haga clic en el icono del menú de acciones y seleccione Exportar:

  

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

  

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

  

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 Mis APIs página:

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

• Seleccionar ambiente: Utilice el menú para seleccionar el ambiente de las APIs que se van a exportar. 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.

• Seleccionar APIs: Una vez que se ha 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 de encabezado se puede usar para 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 del estado de la API:

    Icono	Color	Categoría
    	Verde	La API está publicada.
    	Amarillo	La API se publica con un borrador.
    	Abrir 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 Mis 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 Mis APIs página:

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

• Paso 1: Seleccionar APIs y ambiente

• Paso 2: Seleccionar las APIs que se publicarán

Paso 1: Seleccionar las APIs y el Ambiente

• 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 en el 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 de encabezado se puede utilizar para seleccionar todas las APIs a la vez.

  • API: El nombre de la API.

    Nota

    Una 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 resolverlo, edite uno o ambos valores en la configuración adicional (que se describe a continuación).

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

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

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

  • Configuración adicional: Haga clic en el triángulo de revelación para ver configuraciones adicionales para la API:

    

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

    • Nombre público de API: Muestra la raíz del servicio actual de la URL del servicio de API. Utilice el cuadro de texto para cambiar la Raíz del servicio que se utilizará para la API. Se permiten estos caracteres especiales:

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

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

    • Asignar roles a los 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 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.

      Esta configuración 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).

    • Asignar perfil de seguridad: Opcionalmente, use el menú para seleccionar un perfil de seguridad existente que se usará 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. 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 Harmony.

      Nota

      Al importar una API, solo se puede asignar un único perfil de seguridad a esa API. Una vez importada la API, puedes API para asignar perfiles de seguridad adicionales.

      • Crear nuevo perfil: Haga clic para abrir la pantalla de configuración del perfil de seguridad. Una vez creado el nuevo perfil, estará disponible para ser seleccionado en el menú Asignar perfil de seguridad.

• 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 Mis APIs página.

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

Paso 2: Seleccionar las APIs Que Se Publicarán

• 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 a publicar: Se muestran las APIs previamente seleccionadas para ser importadas:

  • Seleccionar: Opcionalmente, seleccione las APIs que se publicarán al importarlas. Las APIs no seleccionadas se guardan como borradores de APIs. La casilla de verificación en la columna de encabezado se puede utilizar para seleccionar todas las APIs a la vez. A medida que se seleccionan las APIs, los valores en URLs utilizadas se actualizan en consecuencia.

  • 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 de 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 a 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 que se complete la importación) del número total de URLs de API permitidas por la suscripción de la organización. Las URLs de API utilizadas actualmente consisten en aquellas utilizadas por las APIs de servicio OData y personalizadas publicadas y sus clones publicados. Las APIs en borrador no cuentan como URLs de API en uso.

  • Proxy: Refleja la cantidad de URLs de API de proxy que estarán en uso (después de que se complete la importación) del número 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 de borrador no cuentan como URLs de API de proxy en uso.

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

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

• Importar: Haga clic para importar las APIs.

Al hacer clic en Importar, un mensaje indica que las APIs se importaron correctamente:

Si faltan los proyectos, operaciones y entidades asociados en el ambiente de destino, aparecerá un mensaje de error:

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