Connections

To work with your APIs in Developer Portal, you first need to import them by connecting it to an API Gateway — which can be either Sensedia or third-party.

This connection (or integration) allows the synchronization of your API data with Developer Portal.

The Connections screen, accessible from the left sidebar, allows you to configure new connections. You can also view, edit, or delete existing connections.

See below:

Creating a new connection

Follow the steps below to create a new connection.

For AWS gateways: to create a connection ensure you have an AWS connection user for your AWS Gateway and have obtained your credentials.

  1. Go to the Connections screen by clicking the left sidebar menu or the card on the Portal Manager home screen.
    screenshot of the Portal Manager home screen

  2. Click the + CREATE CONNECTION button located in the upper right part of the screen.
    screenshot of the connections screen

  3. In step 1 - PROVIDER, select the provider of the connection.
    detail of the connection creation screen with step 1

  4. Click NEXT.

  5. In step 2 - CONNECTION, provide the following information:

    • Connection mode: Select the connection mode: whether it is native (data updated directly with the provider) or not (manual upload).

      Synchronization with native connections depends on the credentials being registered with the provider.

    • Connection name: Define a name for the connection.

    • For Sensedia gateways:

      • Manager Release: Select a version: API Platform 4.x or API Management 5.x.

        • For API Platform 4.x:

          • Manager domain: URL of your Sensedia API Platform.

          • Token: your access token.

        • For API Management 5.x:

    • For AWS gateways:

  6. In the last step, review the information. If correct, click SAVE.

This video illustrates the steps to create a connection with AWS gateways:

In connections with the Sensedia API Manager, the APIs are imported automatically. See how to import APIs when integrating with AWS API Gateways.

Viewing connection details

To view the general information of a specific connection:

  1. Go to the Connections screen by clicking the left sidebar menu or the card on the Portal Manager home screen.
    screenshot of the Portal Manager home screen

  2. On the Connections screen, click the eye icon of the desired connection.

  3. The next screen will display:

  4. To view API details and its executions, click the eye icon next to the API.
    screenshot of the connection details screen

Editing a connection

Follow the steps below to edit a connection:

  1. Go to the Connections screen by clicking the left sidebar menu or the card on the Portal Manager home screen.
    screenshot of the Portal Manager home screen

  2. Find the connection you want to edit and click the icon view 2 icon.
    Use the search bar to locate the desired connection.

  3. In the upper right area of General Trace, click the icon edit icon.
    screenshot of the connection edit screen

  4. Make the necessary changes and click SAVE.

Importing APIs

To import APIs, follow the steps below:

  1. Go to the Connections screen by clicking the left sidebar menu or the card on the Portal Manager home screen.
    screenshot of the Portal Manager home screen

  2. Find the connection you want to edit and click the icon view 2 icon.
    Use the search bar to locate the desired connection.

  3. On the API Imports screen, click the + IMPORT API button, located just below General Info and above API Imports.
    screenshot of the API import screen

  4. For AWS gateway:

    • Select the region of the APIs you want to import and click SAVE.
      screenshot of the AWS region selection screen

    • Select the APIs you want to import and click SAVE.

For Sensedia gateway, the APIs are automatically imported upon connection.

Connections Listing

Existing connections are listed on the Connections screen.

For each connection (row), the following information (columns) is displayed:

  • PROVIDER:

    • Sensedia API Gateway logo for Sensedia gateways or

    • AWS API Gateway logo for AWS gateways.

  • NAME: connection’s identifier.

  • MODE: connection mode, which can be NATIVE or NON-NATIVE.

  • STATUS: synchronization status of API data:

    • DONE, indicating that the data synchronization was successfully completed;

    • IN PROGRESS, indicating that synchronization is in progress;

    • FAILED, indicating that the synchronization of one or more APIs has failed;

    • SYNC NOT STARTED, indicating that the synchronization process has not started yet;

    • NO IMPORTS, indicating that there are no imported APIs.

  • API COUNT: number of imported APIs.

  • LAST SYNC: date and time of the last synchronization.

Additionally, the ACTIONS column provides the following features:

  • eye icon: to see general connection information and edit its settings.

  • trash can icon: to delete a connection

It’s not possible to delete connections with IN PROGRESS and SYNC NOT STARTED statuses.

You can search for specific connections using the following fields, located above the listing:

  • Name: search by connection name.

  • Provider: search by provider.

  • Status: search by synchronization status.

After filling in the desired fields, click SEARCH. To clear filled fields, click CLEAR. To update the results, click refresh icon.

Connection Details

General Info

To access the screen with connection details, where General Info is located, follow the steps described in the section "Viewing connection details".

connection details screen with general information panel

This panel displays the following information about the selected connection:

  • The synchronization status of API data (at the top left corner):

    • DONE, indicating that data synchronization was successfully completed;

    • IN PROGRESS, indicating that synchronization is in progress;

    • FAILED, indicating that synchronization of one or more APIs failed;

    • SYNC NOT STARTED, indicating that the synchronization process has not yet started;

    • NO IMPORTS, indicating that there are no imported APIs.

  • Connection Name: name of the connection.

  • Mode: connection mode, can be NATIVE or NON-NATIVE.

  • Created At: creation date and time.

  • Created By: name of the user responsible for creating the connection.

  • Updated At: date and time of the last update.

  • Updated By: name of the user responsible for the last update.

  • Last Executed At: date and time of the last data synchronization.

For Sensedia gateways, in addition to the fields above, the following are displayed:

  • Manager Domain: URL of the Sensedia API Manager

  • Token: your Sensedia access token. This data is not displayed for security reasons.

For AWS gateways, in addition to the fields above, the following are displayed:

  • AWS Access Key Id

  • AWS Secret Access Key Id: The key is not displayed for security reasons.


API Imports

Below the general connection information panel, there is the API IMPORTS panel, from which you can manage API imports for the connection.

detail of the integrations screen with the api imports panel

Imports Listing

The APIs are listed in a table, which includes the following columns:

  • NAME: API name;

  • REGION: region where the API is deployed;

  • API ID: API identifier;

  • PROTOCOL TYPE: communication protocol;

  • STATUS: import status:

    • DONE: indicating that the import was successfully completed;

    • IN PROGRESS: indicating that the import is in progress;

    • FAILED, indicating that synchronization of one or more APIs failed;

    • NOT STARTED: indicating that the import has not yet started.

In addition to this information, the ACTIONS column provides the following icons/buttons for you to:

  • icon refresh: update the list. It’s not possible to update data with IN PROGRESS or NOT STARTED status.

  • icon view 2: view more about the import.

  • icon delete: allow deletion of the import. It’s not possible to delete an import with IN PROGRESS or NOT STARTED status.

You can search for specific imports using the following fields, located above the table:

  • Name: search by API name.

  • Status: search by import status.

After filling in the desired fields, click SEARCH. To clear filled fields, click CLEAR. To update the API list, click refresh icon.

Viewing Details of a Specific Import

By clicking the icon view 2 button of a specific import in the imports listing, you can view more information about that import.

You will be redirected to a new screen containing two panels:

  • DETAILS, which displays the import information;

  • EXECUTIONS, which displays a list of information about each attempt to synchronize the import data.

DETAILS

The DETAILS panel presents the following information about the import:

  • API Id: API identifier;

  • Name: API name;

  • Region: region where the API is deployed;

  • Protocol Type: communication protocol,

  • Status: status of the last import update execution:

    • DONE: indicating that the import was successfully completed;

    • IN PROGRESS: indicating that the import is in progress;

    • FAILED, indicating that synchronization of one or more APIs failed;

    • NOT STARTED: indicating that the import has not yet started.

  • Created At: creation date and time;

  • Created By: user responsible for the creation.

You can tell whether the connection is Sensedia (Sensedia) or AWS (AWS) by the icon next to the information.

EXECUTIONS

The EXECUTIONS panel displays a list of information about each attempt to synchronize the import data.

Here you can see:

  • STARTED BY: user who initiated the import execution.

  • STATUS: synchronization status:

    • DONE: indicating that data synchronization was successfully completed;

    • IN PROGRESS: indicating that synchronization is in progress;

    • FAILED, indicating that synchronization of one or more APIs failed;

  • REASON FOR FAILURE: reason for the failure, if the synchronization failed.

  • TYPE: indicates how the execution was initiated, whether automatic (AUTOMATIC) or manual (MANUAL).

  • Started At: start date and time.

  • Finished At: end date and time.

By clicking the icon lens icon over a paper of a specific execution, you can view more information about it in the ACTIONS column:

  • Execution Id: unique identifier of the execution.

  • Log: execution log message.

Thanks for your feedback!
EDIT

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