#
🧩 API
#
⚙️ API management
From the Community Studio, select the badge, then click on the More
button and choose
Generate an API Key
. The key will be created after confirmation via the mobile app. You then simply need to return to the menu and use the
Copy API Key
option.
Access to API Key Generation
The API key generation feature is not yet available for all users. To gain access, please request it from myDid.
#
📖 How the API works
The myDid API allows users and developers to easily integrate badge distribution into their own systems or platforms. Once an API key is generated via the Community Studio, this key serves as a unique identifier to enable secure interactions with the myDid infrastructure.
Information about the API Key
The API key is generated for a specific badge. If the manager wishes to use the API for another badge, a new API key must be regenerated.
With this API, it is possible to automate several badge-related operations, such as:
Generating unique links for a specific badge template.
Retrieving data for a template corresponding to an API key.
Using this request to obtain the status (pending, used, expired) of a generated link by providing the link ID in the URL parameters.
#
💡 Benefits of using the myDid API
Using the myDid API offers numerous advantages for users and businesses:
- Secure Access: Ensures that only authorized applications can interact with your services.
- Automation: Allows for the generation of unique links without manual intervention and the retrieval of template/badge information.
- Personalization: Makes it easy to send specific links to users with personalized information.
- Efficient Tracking: Enables you to check the status of generated links, optimizing resource management.
- Easy Integration: Ensures smooth and direct integration with other systems or applications.
#
➡️ Example of integration
The Masteriyo
plugin for WordPress
allows you to create and manage online courses and integrating the myDid API enables rewarding users who complete these courses with certified badges. These badges, verifiable through the myDid app, enhance the credibility of the acquired skills and allow users to easily share them in professional settings.