Creando un portal de desarrolladores

What is a Developer Portal?

A developer portal is a key tool for those who want to consume your APIs. In the given context, we are talking about a Developer Portal, which is designed to provide application developers with a self-service integration experience. This means that they can easily browse your API catalog, review your documentation, and even sign up to start integrating them into their projects.

What are the functionalities of a Developer Portal?

• Exposure of APIs: The APIs you want to share will be available on the portal, with all their documentation.
• Access control: You can define who can see and use each API you are exposing.
• Web interface: Developers can interact with your APIs through a user-friendly interface.
• Test functionality: Developers are allowed to register their applications and test how to integrate your APIs.

How is an API Proxy update performed?

A Proxy API acts as an interface between the client consuming APIs and the actual service provided. In this context, an upgrade of the Platzi Products API is being performed through APIG. Here are some important steps to follow:

1. New Revision Upload: First, a compressed file (ZIP) with the new CORS (Cross-Origin Resource Sharing) definition is selected.
2. Base Path Configuration: It is essential to adjust the base path in the code to ensure that the API works correctly.
3. API Key Verification: It must be verified that the API Key name is consistent throughout the workflow.
4. Deployment in test environment: Finally, the new revision must be deployed in the test environment and verified to work correctly.

How do I update the API specifications?

API specifications will allow you to define how your API looks and operates. In the scenario described, the following changes were made:

• Base Path setting: As in the Proxy API, the base path must match what is defined in the specification.
• Security Definitions: A new section called Security Definitions is added to manage access.
• HTTPS protocol: It is recommended to change from HTTP to HTTPS for better security.

It is important to make these changes carefully and check the syntax to avoid errors.

How do I create the Developer Portal?

Once you have your APIs ready, the next step is to create an environment where developers can interact with them: the portal.

1. Portal Creation: Starting from the Publish section, a new portal is created.
2. Customization: It is possible to change the theme, icons, and the look and feel of the portal, so that users feel more connected.
3. API Integration: The Platzi Product API is added to the portal catalog.
4. Detailed configuration: Aspects such as title, description and restrictions to only registered users can be defined.
5. Portal Testing: Before final exposure, it is essential to register and verify the experience as it will be for future users.

This process not only allows developers to access your APIs, but also improves the perception and usability of your ecosystem by offering a robust and user-friendly experience.

With these steps, you not only optimize access to your APIs, but also strengthen the relationship with developers by offering integrated and accessible support. Get excited to keep exploring and creating new solutions with APIs!