Release Notes - Developer Portal

New Feature

The Developer Portal now includes the File Repository feature, which allows you to upload, manage, and associate files for use in Guides. This enables you to reuse files across different content and have greater control over storage consumption.

Check out more information on the File Repository page.

Improvements

• Renaming of screens and menu aggregation We renamed the API Docs screen to API Catalog to better align with the API Catalog concept. We also implemented the Content Management aggregator, which brings together the Guides and FAQ menus in a single location, making it easier to access and organize content.

• Automated migration We implemented an automated update process for customers migrating from Sensedia API Platform version 4.x to Sensedia API Management 5.x. Now, the integrations that feed the Developer Portal are migrated seamlessly, preserving authentications, configurations, and data history without the need for manual adjustments.

Bug Fix

• We fixed an issue related to editing Sensedia (API Management 5) connections: when changing the Client ID and/or Client Secret, the Developer Portal did not remove or update the old access token. As a result, the portal continued attempting to use a token linked to possibly revoked or obsolete credentials.

Improvement

• We implemented a bidirectional synchronization logic for app statuses, ensuring that any changes made by administrators are automatically reflected in both the Developer Portal and API Management. For example, when an app is deleted in the source gateway, it will also be removed from the Portal Manager and Developer Portal, and the consumer will be notified about the access revocation.

Improvement

• Authentication Now, the available authentication methods — email login or SSO (Microsoft Entra ID and Keycloak) — are automatically displayed or hidden according to the client's security policies.

New Feature

• Support for HTTP API Import (AWS HTTP API Gateway v2) The Developer Portal now allows you to import HTTP APIs (AWS HTTP API Gateway v2), in addition to the existing support for REST APIs (AWS REST API Gateway v1). This improvement expands the portal's compatibility, making it easier to manage and integrate different types of AWS APIs in a single environment.

Bug Fixes

• We fixed an issue that caused breaks in the Activity Monitor and API Status menus for customers who do not use Sensedia API Management as their API provider. Since these menus depend on data from the Sensedia provider, we added a message informing that no data is available, either due to the absence of a connection with Sensedia or because the configuration has not yet been completed.

• (Strapi) We fixed an issue that caused data inconsistency when trying to create a revision with invalid information. The 400 error was thrown after updating the catalog revisions, without executing the necessary rollback.

• (Strapi) We fixed an issue that created duplicate environment records when trying to register an already existing environment.

New Features

• Role Assignment for Guides You can now assign specific roles for each guide displayed in your Developer Portal. Roles control the visibility and access to guides, allowing administrators to manage permissions in a granular way. This ensures greater security and improves the user experience, ensuring that each person views only the authorized content according to their role. See more information at Role Assignment.

• Email Notification Customization Administrators can now customize emails sent to Developers and Apps directly in the Notifications tab on the Portal screen, aligning communication with the company's visual identity. You can configure the company logo, email title, and email body. NOTE: Notification customization is available for Premium plan customers. For more information, contact your account manager. See more information at Notifications.

Bug Fix

• We fixed an issue with new user registration: now, success or error messages are clearly displayed, preventing duplicate attempts and confusion.

Improvement

• Product Publishing from the "Products" Menu Product publishing in Portal Manager now occurs directly from the Products menu. You can publish a product at the time of its creation, making the process faster and consistent with the usability of other resources, such as APIs and Guides. The publishing option is no longer available in the Portal menu.

Improvement

• Advanced Content Search in the API Catalog We've enhanced the API Catalog search in the Developer Portal to include keywords from the OpenAPI contract content, such as endpoints and descriptions. This makes it easier to discover APIs, even without the exact name.

Improvements

• App Approval Control Now you, a Portal Manager administrator, can define whether app creation will be auto-approved or require manual approval. This new option allows you to manage app credentialing for Sensedia API Management, ensuring greater security and governance in the consumption of your APIs.

• Filter by Provider in the Portal Manager Apps Interface We've added the "Provider" filter and column to the Portal Manager Apps interface. Additionally, we removed the "Credential Status" field and adjusted other interface elements for greater clarity.

Bugs Fixed

We fixed an issue in the Developer Portal Multi-Gateway that, in certain situations, prevented APIs from being listed for selection when creating new apps and products.

New Feature

We've added a FAQ section in Portal Manager. Now you can easily create and manage topics and questions that will then be displayed to developers in the Developer Portal for quick and efficient reference.

Developer Portal Internationalization

With the Developer Portal, developers from different regions can now enjoy a smoother experience. The portal is now multilingual and available in English, Spanish, and Portuguese. You can switch languages by clicking the flag icon in the top right corner of the portal.

Improvement

We have made available an additional access method for developers to your Developer Portal, which now supports SSO (Keycloak) login.

Improvement

In addition to Sensedia, AWS, Azure, and Mulesoft, the Developer Portal now offers native integration with Apigee Gateway, allowing your APIs to be exposed for developer consumption.

Improvement

We added the option for native integration with Mulesoft, allowing you to import and expose APIs directly from the Mulesoft gateway, using the appropriate credentials.

Improvement

• (Strapi) Now available: developer authentication using Microsoft EntraID.

Fix

• (Strapi) Fixed an issue with access permissions to Guides.

Improvements

• (Strapi) You now have the option to control access to the Guides screen in your portal. Select the Roles that can access it. You can assign roles to developers in API Catalog.

• (Strapi) We added a screen to notify that the page is restricted when the developer does not have access to the API catalog, API Status, and Apps.

Fixes

• (Strapi) Fixed the issue that caused an "incorrect username or password" error message when trying to log in after a user's role was deleted and replaced with a default role.

• (Strapi) Duplicate APIs were being displayed on the App creation screen when AWS APIs were associated with roles.

• (Strapi) Fixed the SAVE button, which would become disabled after creating or deleting a role.

• (Strapi) The Products screen was breaking when editing a product that did not exist in Strapi.

Improvement

• (Strapi) Introduced the concept of roles. You can now manage access to your portal by defining roles for developers/users.

Improvements

• We added the secure attribute to portal cookies.

API Status

• (Strapi) We created a new screen for your Developer Portal: API Status. Consumers of your APIs can now check resource availability details for the APIs.

Fixes

• Fixes implemented in the Developer Portal Strapi:

  • Logged-in users in the Developer Portal were unable to view the Catalog and Apps pages.

  • The Catalog screen layout in the Developer Portal would break when publishing a product with a very large description. This fix was applied to both Strapi and non-Strapi versions of the Developer Portal.

  • Fixed a 404 error when loading the favicon.

  • The restricted area screen was not being displayed for non-logged-in users.

Delivery

The Developer Portal integrated with Strapi is now available.

Improvements

• Created the "Developers" tab in Settings. The auto-approval setting for developer registrations is now in this tab.

• Revised the ReCAPTCHA component in the password reset and developer registration confirmation forms.

Fix

• Fixed the issue with API names containing special characters.

Fix

• Implemented necessary adjustments for compatibility with Sensedia API Manager version 5.

Improvement

• Adjusted the rule for API deletion. It is now only possible to delete APIs that were manually imported. APIs imported automatically and non-native ones cannot be deleted individually.

Fixes

• Resolved an issue when attempting to import a custom provider.

• Fixed a problem when re-importing an API from a non-native connection.

• AWS Apps listing now only returns native connections.

Improvements

• You can now send additional information (e.g., tokens) along with AWS app credentials.

• Added a new element to the AWS App creation and approval flow: the AWS API Key ID field.

Fix

• Fixed an issue that caused an error when removing apps from an AWS API without plans.

Fix

• Fixed an issue that resulted in an error when changing credentials while approving an AWS app modification.

New Feature

• You can now manage AWS Apps, approving or rejecting new registrations.

New Feature

• Created the Consumers > Apps page, dedicated to AWS gateway Apps.

Delivery

First release of the Developer Portal product.