Skip to main content
Version: 2.0.0

Developer Portal

Welcome to the Ejento AI Developer Portal tutorial. This guide will walk you through the steps to manage your API subscription keys, test our APIs using the keys, and navigate the portal.

Accessing the Developer Portal​

To start, you need to access the Developer Portal.

  1. Login to your account.
  2. From the dashboard, navigate to the API KEYS section.

1. Click on Sign In​

Step 1 screenshot

2. Under Admin Panel in the Sidebar, Click on API Keys​

Step 2 screenshot

3. Here is the Developer Portal Section​

Step 3 screenshot

Creating New API Key​

1. Click on "Create new secret key"​

Step 1 screenshot

2. Name your key in this field​

Step 1 screenshot

3. Here, you can see different permission scopes: All, Read Only, and Restricted​

Step 2 screenshot

4. Permission: All​

The user gets access to all the APIs​

Step 3 screenshot

5. Permission: Read Only​

The user gets access to only GET requests​

Step 4 screenshot

6. Permission: Restricted​

Category level Permissions:​

None: No access to any operations in the category.​
Read: Access to only GET requests under that category​
Write: Access to all the APIs under that category (GET, POST, PUT, DELETE, etc.)​

Step 5 screenshot

7. Select Permission for each category​

Step 6 screenshot

8. Click on Create​

Step 7 screenshot

Step 4 screenshot

Step 5 screenshot

11. In the new tab, Click on Allow access to activate your key​

Step 6 screenshot

12. Copy your secret key and click on "Done"​

Step 7 screenshot

13. Your new key will appear in the list of API keys.​

Step 8 screenshot

Testing API Key in the REST API Playground​

You can test your newly generated API keys using the API Playground under the REST API section on docs.ejento. This playground allows you to experiment with different API endpoints and see real-time responses using your keys.

1. Click on View API documentation, you'll be redirected to REST API documentation​

Step 1 screenshot

2. The list of all endpoints can be seen in the sidebar​

Step 2 screenshot

3. Choose one of the endpoints to test your new key​

Step 3 screenshot

4. Paste your new key in the Ocp-Apim-Subscription-Key field.​

Step 4 screenshot

5. Click on Send API Request​

Step 5 screenshot

6. The response from the API can be seen here​

Step 6 screenshot

Deleting API Key​

If you need to delete a key:

  1. Navigate to the Keys List.
  2. Click the delete icon next to the key you want to remove.
  3. Confirm the deletion by clicking "Yes" in the confirmation prompt.

1. Navigate to the API Keys List​

Step 1 screenshot

2. Click the delete icon next to the key you want to remove​

Step 2 screenshot

Click on "Revoke"​

Step 3 screenshot

The key has been removed from the API Keys List​

Step 4 screenshot