Apps

Accessing Apps in your custom page of Developer Portal, you will be able to:

For Sensedia Connections:

For AWS Connections:

Apps list

To access the Apps page in Developer Portal, you need to be logged in.

The page has a search tool that allows you to filter Apps by API or App name.

The image below is illustrative and may vary depending on the customization made for your Developer Portal.

develop portal apps screen

The table listing the Apps contains the following columns:

  • Icon: icon registered for the App. This registration is optional.
    Supported formats: JPG/JPEG, PNG, BMP, and GIF.
    Maximum image size: 140 x 140 pixels. Maximum file size: 1 MB.

  • App name: name registered for the App.
    Length: from 3 to 256 characters.

  • Description: description registered for the App.
    Length: 3 to 512 characters.

  • Credentials: link to obtain the Client ID and Client Secret;

  • Status: whether the App is enabled for use or not:

    • Approved: enabled for use;

    • Pending: waiting for approval or rejection;

    • Rejected: App that was pending and was rejected;

    • Canceled: App canceled or deleted;

  • Actions:

    • magnifying glass icon on top of a piece of paper: see an overview containing App description, credentials, list of APIs (with description, version, and API revision) and Access Tokens (with status, expiration date, and owner).).

    • pencil icon: edit the API.

For Sensedia Gateway Connections

Creating an App (Sensedia)

If your gateway is Sensedia, follow these steps to create an App:

  1. Access your Developer Portal.

  2. Click Apps, located in the top right corner of the screen.
    The image below is illustrative and may vary depending on the customization made for your Developer Portal.
    app button

    It is necessary to:

    • log in to use this feature;

    • have a Sensedia gateway registered;

  3. Click + CREATE NEW APP. The image below is illustrative and may vary depending on the customization made for your Developer Portal.
    list of apps with emphasis on the button for creating an App

  4. Fill in the Basic info fields with the App’s name and description. If you wish, you can enter a link and add an image. Apps basic info fields

  5. In Available APIs, select the Sensedia gateway.
    Admins: if the gateway is not available, check the configuration in the Connections section.

  6. Select one or more APIs.
    There must be plans registered for the APIs.
    App creation

  7. Review the settings and click CONFIRM.
    screen for reviewing App settings

The App will be displayed in the Apps list.


For apps created in Sensedia API Management via the Developer Portal, it is not possible to define Inbound Addresses at the time of creation.

When no Inbound Address is selected, the app is automatically replicated to all available data planes in Sensedia API Management.

If you need to restrict the app to specific data planes, this configuration can be done through customizations offered by Sensedia’s managed services.

See more in Creating Apps.

Editing an App (Sensedia)

Follow these steps to edit an App:

  1. Access your Developer Portal.

  2. Click Apps, located in the top right corner of the screen.
    You need to be logged in to use this feature.
    The image below is illustrative and may vary depending on the customization made for your Developer Portal.
    Apps button

  3. Locate the App to be edited. You can search by API name or App.

  4. In the ACTIONS column, click pencil icon to edit.
    icon to access App editing

    Only Apps with APPROVED status can be edited.

  5. Edit the App configuration and click SAVE.

  6. Check the information and click CONFIRM.

For AWS Gateway Connections

Creating an App (AWS)

Registering Apps for AWS connections follows steps similar to registering Apps for Sensedia connections.

The main differences are the need for approval and the fact that it is not necessary to have a plan associated with the API.

If your gateway is AWS, follow these steps to create an App:

  1. Access your Developer Portal.

  2. Click Apps, located in the upper right corner of the screen.
    You must be logged in to use this feature.
    Apps button

  3. Click the + CREATE NEW APP button.
    The image below is illustrative and may vary according to the customization made for your Developer Portal. list of apps with emphasis on the create App button

  4. Fill in the Basic info fields with the App name and description.
    App basic info fields

  5. In Available APIs, select the AWS gateway.

  6. Select one or more APIs.

  7. Review the settings and click CREATE.

  • The App will be listed in Developer Portal with the status Pending.

  • The administrator should approve or reject the App registration in Portal Manager in Consumers  Apps.

  • Other actions related to the management of AWS Apps are also performed in Portal Manager.

    • For the auto-approval of AWS Apps, configure the Webhook accordingly.


Editing an AWS App (AWS)

Follow these steps to edit an App:

  1. Access your Developer Portal.

  2. Click Apps, located in the upper right corner of the screen.
    You must be logged in to use this feature.
    The image below is illustrative and may vary according to the customization made for your Developer Portal.
    Apps button

  3. Locate the App to be edited. You can search by API name or App name.

  4. In the ACTIONS column, click the pencil icon icon to edit.
    icon to access App editing

    Only Apps with the status APPROVED can be edited.

  5. Edit the App and click SAVE.

  6. Review the edited information.
    Should everything be correct, click CONFIRM.

Thanks for your feedback!
EDIT

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