Managing API keys
The MyJadu API is a RESTful interface to the content in Jadu. The API allows third party developers to request site content to be returned to them as XML.
This allows them to build their own applications based on the content of a Jadu site.
Managing API key requests
If the MyJadu API is enabled for public or private access, registered website users can apply for an API key. They can do this by following a link on their personal website account page.
If the MyJadu API is privately enabled then the request will be marked as pending and must be approved by a Control Center administrator.
When the API key is activated, the user will be notified via email.
MyJadu API is managed via the Settings menu.
If your account has permission to access MyJadu API, you navigate to the management area by the following:
- Click the Settings icon in the left navigation bar. The Settings menu will open.
- Click the API link in the fifth group of links. The list of site visitor API keys will be shown.
- Find the site visitor's registered email address in the list
MyJadu API key fields
| Field | Notes | Required? |
|---|---|---|
| User ID or E-mail address | Registered email address for the linked site visitor. | ✅ |
| Usage description | ||
| Status | The status of the API key, either active, pending or disabled. Active: the API key can be used to retrieve XML data from the website. Pending: a user has requested an API key but the request has yet to be granted. Disabled: the API key cannot be used to retrieve XML data from the website. | |
| API Module Access | Areas of the API this key can access. |
Creating an API key for a user
It is possible to create an API key for a user rather than have them do this via the public facing website.
- Navigate to the API Key management area.
- Click the New API key button. The API key form will open.
- Complete the required details and click Save to save your changes.
When an API key has been created the user will be emailed to notify them of their new API key.
Regenerating an API Key
It may become necessary to regenerate an API can. This may be required if it is believed that an unauthorised person has gained access to a user's API key.
A new key can be generated and communicated to a user for them to continue using the API while the unauthorised person will no longer be able to use the key they have.
- Navigate to the API Key management area. Locate the user in the list and click their email address to open their record.
- Click the Actions button and select Regenerate API key from the available options.
Once the key has been regenerated it will be emailed to the user.