Skip to main content
Feedback

Developer Portal

Updated 

Deliver a secure, on-premises Developer Portal deployed on Boomi Cloud API Management - Local Edition platform. You can use the out-of-the-box configurations (pre-defined Local Edition templates) to give your developers self-service portal access, or customize a Developer Portal yourself for a uniquely branded experience.

Similar to the Boomi Cloud API Management Developer Portal, Local Edition's Developer Portal features include the ability to create interactive documentation and manage API keys.

Portal Roles

You need the Administrator role to configure and manage your Developer Portal.

Default Developer Portal Pages

The Developer Portal gives you several developer-facing integrations for interacting with your APIs:

  • Home

  • Applications

  • Keys

  • Interactive APIs

Home

The Home page is the landing page for your Developer Portal and the gateway to your API community. Use it to welcome your users to your Developer Portal, direct them to your Developer Portal's APIs, and provide clear steps on how to become a community member, including how to register for a developer key.

Applications

The Applications page displays all the registered applications.

Keys

A Package Key is given to a developer to access a set of services, endpoints, and methods as defined in the respective Package Plan. A plan associated with a Package Key can be replaced with another plan in the same package without changing the key string and without requiring a developer to change the application code.

The Keys page displays a list of package keys owned by the users in the system.

Interactive APIs

The Interactive APIs page is an interactive documentation system for RESTful and SOAP-based APIs that are registered on the Developer Portal.

On this Page