Connections

Para trabajar con sus APIs en el Developer Portal, primero necesita importarlas a través de una conexión con una API Gateway, que puede ser de Sensedia u otros proveedores.

Esta conexión o integración le permite la sincronización de los datos de sus APIs con el Developer Portal.

La pantalla Connections, accesible desde el menú lateral izquierdo, le permite configurar nuevas conexiones. También puede ver, editar o eliminar conexiones existentes.

A continuación:

Creando una nueva conexión

Siga los pasos abajo para crear una nueva conexión:

Antes de crear una conexión a través del Portal Manager, cree un usuario de conexión AWS en su AWS Gateway y obtenga sus credenciales.

  1. Acceda a la pantalla Connections haciendo clic en el menú lateral izquierdo o en la tarjeta en la pantalla de inicio del Portal Manager del Developer Portal.
    captura de la pantalla inicial del Portal Manager

  2. Haga clic en el botón + CREATE CONNECTION, ubicado en la parte superior derecha de la pantalla.
    captura de pantalla de las conexiones

  3. En el paso 1 - PROVIDER, seleccione el proveedor de la conexión.
    detalle de la pantalla de creación de conexión con el paso 1

  4. Haga clic en NEXT.

  5. En el paso 2 - CONNECTION, proporcione la siguiente información:

    • Connection mode: Seleccione el modo de conexión, ya sea nativa (datos actualizados directamente con el proveedor) o no nativa (carga manual).

      La sincronización en conexiones nativas depende de que las credenciales estén registradas en el proveedor.

    • Connection name: Defina un nombre para la conexión.

    • Para gateways de Sensedia:

      • Manager Release: Seleccione una versión: API Platform 4.x o API Management 5.x.

        • Para API Platform 4.x:

          • Manager domain: URL de su Sensedia API Platform.

          • Token: su token de acceso.

        • Para API Management 5.x:

    • Para gateways de AWS:

  6. En el último paso, revise la información. Si es correcta, haga clic en SAVE.

Este vídeo ilustra los pasos para crear una conexión con gateways AWS:

En conexiones con el Sensedia API Manager, las API se importan automáticamente al crear la conexión. Vea cómo importar APIs cuando la conexión es con AWS Gateways.

Visualizando detalles de la conexión

Para ver la información general de una conexión específica:

  1. Acceda a la pantalla Connections haciendo clic en el menú lateral izquierdo o en la tarjeta en la pantalla de inicio del Portal Manager del Developer Portal.
    captura de la pantalla inicial del Portal Manager

  2. En la pantalla Connections, haga clic en el ícono ícono de un ojo de la conexión deseada.

  3. En la siguiente pantalla, verá:

  4. Para ver los detalles de la API y sus ejecuciones, haga clic en el ícono ícono de un ojo de la API.
    detalle de la pantalla de connections

Editando una conexión

Siga los siguientes pasos para editar una conexión:

  1. Acceda a la pantalla Connections haciendo clic en el menú lateral izquierdo o en la tarjeta en la pantalla de inicio del Portal Manager del Developer Portal.
    captura de la pantalla inicial del Portal Manager

  2. Encuentre la conexión que desea editar y haga clic en el ícono icon view 2.
    Si es necesario, utilice la barra de búsqueda para localizar la conexión deseada.

  3. En la parte superior derecha de General Trace, haga clic en el ícono icon edit.
    pantalla de edición de conecciones

  4. Realice los cambios necesarios y haga clic en SAVE.

Importando APIs

Para importar APIs, siga los siguientes pasos:

  1. Acceda a la pantalla Connections haciendo clic en el menú lateral izquierdo o en la tarjeta en la pantalla de inicio del Portal Manager del Developer Portal.
    captura de la pantalla inicial del Portal Manager

  2. Encuentre la conexión que desea editar y haga clic en el ícono icon view 2.
    Si es necesario, utilice la barra de búsqueda para localizar la conexión deseada.

  3. En la pantalla API Imports, haga clic en el botón + IMPORT API, ubicado justo debajo de General Info y encima de API Imports.
    pantalla de importación de APIs

  4. Para gateway AWS:

    • Seleccione la región de las APIs que desea importar y haga clic en SAVE.
      pantalla de importación de APIs para AWS

    • Seleccione las APIs que desea importar y haga clic en SAVE.

Para gateway Sensedia, la importación de las APIs se realiza automáticamente al crear la conexión.

Listado de conexiones

Las conexiones ya creadas se enumeran en la pantalla Connections.

Para cada conexión (fila), se muestran la siguiente información (columnas):

  • PROVIDER:

    • logo Sensedia API Gateway para gateways de Sensedia o

    • logo AWS API Gateway para gateways de AWS.

  • NAME: nombre identificador de la conexión.

  • MODE: modo de conexión, puede ser NATIVE o NON-NATIVE.

  • STATUS: estado de la sincronización de los datos de las APIs:

    • DONE, indica que la sincronización de los datos se ha completado correctamente;

    • IN PROGRESS, indica que la sincronización está en curso;

    • FAILED, indica que la sincronización de una o más APIs ha fallado;

    • SYNC NOT STARTED, indica que el proceso de sincronización aún no ha comenzado;

    • NO IMPORTS, indica que no hay APIs importadas.

  • API COUNT: cantidad de APIs importadas.

  • LAST SYNC: fecha y hora de la última sincronización.

Además de esta información, la columna ACTIONS muestra los siguientes botones:

  • ícono de un ojo: muestra información general de la conexión y permite editar su configuración.

  • ícono de una papelera: permite eliminar una conexión.

No se pueden eliminar conexiones con estado IN PROGRESS y SYNC NOT STARTED.

Es posible buscar conexiones específicas utilizando los siguientes campos, ubicados encima de la lista:

  • Name: busca por nombre de conexión.

  • Provider: busca por proveedor.

  • Status: busca por estado de sincronización.

Después de completar los campos deseados, haga clic en SEARCH para filtrar la lista. Para borrar los campos completados, haga clic en CLEAR. Para actualizar los resultados, haga clic en ícono de recargar.

Detalles de la conexión

General Info

Para acceder a la pantalla con los detalles de la conexión, siga los pasos descritos en la sección "Visualizando detalles de la conexión".

detalle de la pantalla de connections con panel de General Info

Este panel muestra la siguiente información sobre la conexión seleccionada:

  • El estado de la sincronización de los datos de las APIs (en la esquina superior izquierda):

    • DONE, indica que la sincronización de los datos se ha completado correctamente;

    • IN PROGRESS, indica que la sincronización está en curso;

    • FAILED, indica que la sincronización de una o más APIs ha fallado;

    • SYNC NOT STARTED, indica que el proceso de sincronización aún no ha comenzado;

    • NO IMPORTS, indica que no hay APIs importadas.

  • Connection Name: nombre de la conexión.

  • Mode: modo de conexión, puede ser NATIVE o NON-NATIVE.

  • Created At: fecha y hora de creación.

  • Created By: nombre del usuario responsable de la creación de la conexión.

  • Updated At: fecha y hora de la última actualización.

  • Updated By: nombre del usuario responsable de la última actualización.

  • Last Executed At: fecha y hora de la última sincronización de datos.

Para gateways Sensedia, además de los campos anteriores, se muestran:

  • Manager Domain: URL de Sensedia API Manager

  • Token: su token de acceso de Sensedia. Este dato no se muestra por razones de seguridad.

Para gateways AWS, además de los campos anteriores, se muestran:

  • AWS Access Key Id: clave de acceso de su recurso AWS.

  • AWS Secret Access Key Id: secreto de la clave AWS. Este dato no se muestra por razones de seguridad.


API Imports

Debajo del panel de información general de la conexión se encuentra el panel API IMPORTS, donde se pueden gestionar las importaciones de APIs para la conexión.

detalle de la pantalla de integraciones con el panel de importaciones api

Listado de importaciones

Las APIs se listan en una tabla, que contiene la siguiente información en sus columnas:

  • NAME: nombre de la API;

  • REGION: región en la que está implementada la API;

  • API ID: identificador de la API;

  • PROTOCOL TYPE: tipo de protocolo de comunicación;

  • STATUS: estado de la importación:

    • DONE: indica que la importación se ha completado correctamente;

    • IN PROGRESS: indica que la importación está en curso;

    • FAILED: indica que la sincronización de una o más APIs ha fallado;

    • NOT STARTED: indica que la importación aún no ha comenzado.

Además de esta información, la columna ACTIONS muestra los siguientes íconos/botones para que pueda:

  • icon refresh: actualizar los datos de la importación. No es posible actualizar una importación con estado IN PROGRESS o NOT STARTED.

  • icon view 2: ver más detalles sobre la importación.

  • icon delete: permite eliminar la importación. No es posible eliminar una importación con estado IN PROGRESS o NOT STARTED.

Puede buscar importaciones específicas utilizando los siguientes campos, ubicados encima de la tabla:

  • Name: buscar por nombre de la API.

  • Status: buscar por estado de la importación.

Después de completar los campos deseados, haga clic en SEARCH para realizar la búsqueda. Para borrar los campos completados, haga clic en CLEAR. Para actualizar la lista de APIs, haga clic en ícono de recargar.

Visualizando detalles de una importación específica

Al hacer clic en el botón icon view 2 de una importación específica en la listagem de importações, puede ver más detalles sobre esa importación.

Será redirigido a una nueva pantalla que muestra dos paneles:

  • DETALLES, que muestra información de la importación;

  • EJECUCIONES, que muestra una lista con información sobre cada intento de sincronización de datos de la importación.

DETAILS

El panel DETALLES muestra la siguiente información sobre la importación:

  • API Id: identificador de la API;

  • Name: nombre de la API;

  • Region: región en la que está implementada la API;

  • Protocol Type: tipo de protocolo de comunicación;

  • Status: estado de la última ejecución de la importación:

    • DONE: indica que la importación se ha completado correctamente;

    • IN PROGRESS: indica que la importación está en curso;

    • FAILED: indica que la sincronización de una o más APIs ha fallado;

    • NOT STARTED: indica que la importación aún no ha comenzado.

  • Created At: fecha y hora de creación;

  • Created By: usuario responsable de la creación.

Puede saber si su conexión es Sensedia (Sensedia) ou AWS (AWS) por el ícono junto a la información.

EXECUTIONS

El panel EXECUTIONS muestra una lista con información sobre cada intento de sincronización de datos de la importación.

Aquí puede ver:

  • STARTED BY: usuario que inició la ejecución de la importación.

  • STATUS: estado de la sincronización:

    • DONE: indica que la sincronización de datos se ha completado correctamente;

    • IN PROGRESS: indica que la sincronización está en curso;

    • FAILED: indica que la sincronización de una o más APIs ha fallado;

  • REASON FOR FAILURE: motivo del error, en caso de que la sincronización haya fallado.

  • TYPE: indica cómo se inició la ejecución, si de forma automática (AUTOMATIC) o manual (MANUAL).

  • Started At: fecha y hora de inicio.

  • Finished At: fecha y hora de finalización.

Al hacer clic en el ícono ícono de una lupa sobre una hoja de papel de una ejecución específica, puede ver más detalles sobre ella en la columna ACTIONS:

  • Execution Id: identificador único de la ejecución.

  • Log: mensaje del registro de la ejecución.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]