APIIDA API Control Plane

API Control Plane 2024.2

New Features / Changes

  • Improved the way metrics are processed and stored, which increases accuracy and responsiveness of metrics on several platforms.

  • New and improved documentation in environment creation wizard.

  • Added "Allow Subscription in Self-Service" switch for API products. Only if enabled, subscriptions will be possible in developer portal.

  • Added read-only overview over all rules within a rule set.

  • Added editor for rule set files.

  • Added option to assign rule sets to organizations. Rule sets will only be applied to APIs from assigned organizations. If no organizations are assigned, rule sets will be applied globally.

  • In application overview, show metrics from production and non-production enviroments, like in API overview.

  • Emails sent by developer portal are now branded and the email footer text can be customized.

  • Removed some stacktraces and unnecessary lines from agent logs, to improve readability.

  • Menu item ‘Governance’ has been added to tutorial for new users.

  • Added the ability to change the plan of an existing subscription. A new switch has been added for developer portals, to configure if this feature is available from the portal.

  • Improved error messages reported by rule set validation.

  • Added new advanced configuration option to control how APIs are merged during API discovery. Instead of the name reported by the gateway itself, it is now possible to use the title or first tag from the OpenAPI specification.

  • Added oAuth callback url and scope to applications. As of now, these values will be included when the application is deployed to Layer 7.

  • Added ability to upload and versionate terms of use documents that can be attached to some or all API products as well as developer portals. In the developer portal, each user will be required to confirm the attached documents when subscribing to an API product or when registering (setting their password). Additionally, the exact version of the confirmed documents for a user or a subscription can be found in admin-portal.

  • Add option to limit access for subscribing or publishing APIs in certain environments. Instead of being publicly available, environments can be configured so that only users from selected organizations are allowed to subscribe or publish APIs.

  • Added option to overwrite how API urls are generated. The url pattern that is normally reported by the agent can now be overwritten for each API. Additionally, the way that this pattern is integrated into the environment URL can now be configured, potentially overwriting the platform default for that environment.

  • Added webhooks. You can now register webhooks and link them to certain events (currently creation and deletion of subscriptions). When the event occurs, a JSON payload is sent to the webhook URL containing detailed information. If transmission fails, it will be attempted again later, with exponential backoff. It is also possible to manually retry or permanently cancel a failed transmission.

Bug Fixes

  • Fixed a bug where API product icon did not show in the menu.

  • Fixed layout issues in onboarding page.

  • Fixed overlapping text in API overview.

  • Fixed an issue where the developer portal would show tags not belonging to any visible API.

  • Fixed wrong icon in set password page.

  • Fixed a bug where the frontend would fail to show multiple dialogs in succession.

  • Fixed word wrapping in API specification page.

  • Fixed a bug where self-registering a new organization would fail if an organization with the same display name already exists.

  • Fixed a bug where the logo of a branded developer portal would not be used in the set password page.

  • Fixed a bug where unreleased API versions would show up in developer portal.

  • Fixed some mistakes in OpenAPI documentation of API control plane backend.

  • Fixed an issue where the wrong color scheme was applied to some buttons in developer portal.

  • Fixed a security issue where users from consumer organizations could still manually access parts of the backend Rest API that should only be accessible for users that can log into admin portal.

  • Fixed wrong error message when selecting a too large interval in metrics page.

  • Fixed a bug where developer portal did not show owner information about APIs and API products that were not owned by the current users organization.