The Developer Portal is most easily understood by working with the product. To that end, we have created a set of guides to cover common use cases and scenarios, as well as different personas that may interact with the Developer Portal.
If you’re ready to get some hands-on experience, we recommend following the Getting Started guide. Once complete, you can explore other use cases and personas.
We think there are four different personas that will interact with the Developer Portal. All four personas may in fact be the same person, especially in smaller organizations. To more easily find guides relevant to your responsibilities, we have organized the guides by persona.
- Developers - Developers will generate the OpenApi documents the portal uses to create API Docs. They may be responsible for uploading the OpenApi or gRPC documents to the portal.
- Product Owners - Product Owners will create the API Products that consume the information stored in API Docs. They will have knowledge of where services are deployed in the environment, and will be able to wire together the API Docs and routes into the API Product object.
- Portal Admins - Portal Admins will create the consumer facing portals that utilize the API Products created by the product owners. Portal admins will configure the access plan associated with each portal and grant end users access to the portal.
- Consumers - Consumers will log into the portal to test out the published API Products, and interact directly with the API Products using keys retrieved from the portal.