Release Notes: API Developer Portal
These Release Notes summarize the new and enhanced features, known issues, resolved issues, and compatibility matrix for CA API Developer Portal 4.3.x.
Telemetry is a capability that is integrated into CA API Developer Portal as of version 4.3, which collects and sends product usage and system configuration information to CA Technologies, a Broadcom company (CA). This data helps CA gain insights into PLA customers' product usage, understand their software needs, and focus on the features and platforms that are most commonly used. Telemetry feature is only applicable to PLA customers. For more information, see Configure Telemetry.
Assign API Plans
Publishers can now use API Plans to control how APIs can be consumed by developers and applications within an organization. An API Plan comprises rate limit and/or quota information, along with the public or private APIs that these controls apply to.
Enhanced API View and Search
Manage APIs more intuitively using improved display and search capabilities. APIs can now be viewed as cards with essential information such as state, version, applications, and other relevant metadata, while the new search function supports auto suggest, recent searches, as well as filtering and sorting. For more information, see Manage APIs.
Search User Using Name and Email Address
Search users (Publishers or Developer type) using their name and email address from the Users page. For more information, see Manage User.
Mutual SMTP Authentication between Client and Portal
Client and API Portal can mutually authenticate each other using their corresponding trusted certificates. When configuring external mail server, you can upload the client certificate so that both client and API Portal can be mutually authenticated, providing a better and trusted connection. For more information, see the Configure SMTP at the Tenant-level section in Configure and Use External Mail Server.
View an Aggregated Analytics Dashboard
To save disk space and issues leading to slow or no response, API Portal can now display the Analytics data in an aggregated format. If this feature is enabled, the raw data is purged after a day. For more information, see Aggregated Analytics Dashboard.
Assign IdP users to Multiple Organizations and Roles through PAPI
Using the updated Portal API (PAPI) Swagger file, administrators can now assign IdP users to multiple organizations and roles before the first login. For more information, see Portal API (PAPI).
Support for Gateway Enrollment with Prefixed OTK
API Portal now supports enrolling Gateways with a prefixed OTK. For more information, see Enroll a CA API Gateway.
Gateway 9.4 Compatibility
API Developer Portal4.3.1 is compatible with CA API Gateway 9.4 and CA OTK 4.3.1. See Compatibility Matrix for details.
Customize Core Portal Pages
Customization of the
API Developer Portalpages is made easy by bundling all customized pages in a zip file and uploading on portal. The following pages can be customized:
- Sign Up
- Account Setup
- Reset Password
- New Password
You (Portal or Tenant administrator) can either use templates or use your own pages. A list of APIs are also provided to ensure that the pages work as expected. For more information, see Customize Core Pages.
Custom Domain Names
The Administrator can change the default URL to a custom domain name. For more information, see Set Up Custom Domain Names.
Encrypt API Keys and Secrets
With this release, all key and secret attributes on applications (also known as API keys and secrets) have been encrypted.
Only Portal database keys and secrets are encrypted. If you are using the OAuth Toolkit (OTK), data will be decrypted prior to sync with the OTK database.
Jarvis Externalization for Improved Performance and Stability
Jarvis is now run as a separate analytics service that the
API Developer Portalconnects to. This service decoupling addresses performance issues and stability improvements. See Integrate Jarvis Analytics
Set up external Jarvis and migrate your existing Jarvis data before installing or upgrading to the new
API Developer Portal. Portal upgrade will fail if existing data has not been migrated. For more information, see Configure External Jarvis Service.
Set Jarvis Data Retention Period
You can now set a data retention period for your Jarvis service. The optimum retention period will depend on your volume of usage and available nodes per component. For more information, see Jarvis Hardware Optimizer.
Map Developers to Multiple Organizations
Administrators can now assign Developers to multiple organizations and corresponding roles. This applies to developers who were added in Portal as well as developers who log in to Portal using an external authentication scheme. For the externally authenticated developers, the Portal administrator has to set the authorization type of the corresponding authentication scheme to Portal. The authorization type field is added in this release and is available while adding or editing the user authentication scheme.
For more information, see:
Migrate PostgreSQL Data to MySQL
You can now migrate your PostgreSQL database to a production-ready external MySQL database. For more information, see Configure an External Database.
Important!The packaged database migration script is currently non-functional. We apologize for the inconvenience.
Configure Cookie Banner
The Administrator can now enable or disable cookie banners to convey the cookie usage and fulfill the legal requirements. The content in the cookie banner can also be customized. For more information, see Customize Page Appearance.
With audit logs, the Administrator can now see a history of actions that are performed on certain objects. The Administrator can also view and sort audit logs in the UI or using an API call. Audit logs can be filtered and exported using an API call. For more information, see Audit Logs.