Developer Portal

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

Accessing the Developer Portal

To start, you need to access the Developer Portal.

From the dashboard, navigate to the API KEYS section.

1. Go to the Admin Panel from the sidebar.

2. Under Admin Panel in the Sidebar, Click on Settings

3. Click on API Keys

4. From here, copy your server URL, which you’ll need to pass as the baseURL when using the APIs.

5. From here, you can copy your auth token, which you’ll need to include in the header as a Bearer token when using the APIs.

Creating New API Key

1. Click on "Create new secret key"

2. Name your key in this field

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

4. Permission: All

The user gets access to all the APIs

5. Permission: Read Only

The user gets access to only GET requests

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.)

7. Select Permission for each category

8. Click on Create

9. Click here to follow the link

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

11. Copy your secret key and click on Done.

The key will only be shown once, so make sure to copy and save it — you won’t be able to view it again.

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

Testing API Key in the REST API Playground

You can test your newly generated API keys using the API Playground on api.ejento.ai. 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 Ejento APIs

2. Choose one of the endpoints to test your new key

3. Click on Try it

4. Click on this icon

5. Click on `your-server-name` variable to set your dynamic base URL.

6. Here, you’ll need to replace these variables with their actual values.

7. Paste the values you copied and saved.

Replace your-server-name with the Server URL you copied in step 4.
Replace your-api-key with the API Key you created.
Replace your-access-token with the Authorization Token you copied in step 5.

8. Click on Save & Exit

9. Give the required parameters

10. Click on Send

11. The response from the API can be seen here

Deleting API Key

If you need to delete a key:

Navigate to the Keys List.

Click the Delete Key icon next to the key you want to remove.

Confirm the deletion by clicking "Revoke" in the confirmation prompt.

API Keys

Developer Portal

Accessing the Developer Portal

1. Go to the Admin Panel from the sidebar.

2. Under Admin Panel in the Sidebar, Click on Settings

3. Click on API Keys

4. From here, copy your server URL, which you’ll need to pass as the baseURL when using the APIs.

5. From here, you can copy your auth token, which you’ll need to include in the header as a Bearer token when using the APIs.

Creating New API Key

1. Click on "Create new secret key"

2. Name your key in this field

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

4. Permission: All

5. Permission: Read Only

6. Permission: Restricted

7. Select Permission for each category

8. Click on Create

9. Click here to follow the link

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

11. Copy your secret key and click on Done.

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

Testing API Key in the REST API Playground

1. Click on View API documentation, you'll be redirected to Ejento APIs

2. Choose one of the endpoints to test your new key

3. Click on Try it

4. Click on this icon

5. Click on `your-server-name` variable to set your dynamic base URL.

6. Here, you’ll need to replace these variables with their actual values.

7. Paste the values you copied and saved.

8. Click on Save & Exit

9. Give the required parameters

10. Click on Send

11. The response from the API can be seen here

Deleting API Key

1. Click the Delete Key icon next to the key you want to remove

2. Click on "Revoke"

API Keys

Developer Portal#

Accessing the Developer Portal#

1. Go to the Admin Panel from the sidebar.#

2. Under Admin Panel in the Sidebar, Click on Settings#

3. Click on API Keys#

4. From here, copy your server URL, which you’ll need to pass as the baseURL when using the APIs.#

5. From here, you can copy your auth token, which you’ll need to include in the header as a Bearer token when using the APIs.#

Creating New API Key#

1. Click on "Create new secret key"#

2. Name your key in this field#

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

4. Permission: All#

5. Permission: Read Only#

6. Permission: Restricted#

7. Select Permission for each category#

8. Click on Create#

9. Click here to follow the link#

10. In the new tab, Click on Allow access to activate your key#

11. Copy your secret key and click on Done.#

12. Your new key will appear in the list of API keys.#

Testing API Key in the REST API Playground#

1. Click on View API documentation, you'll be redirected to Ejento APIs #

2. Choose one of the endpoints to test your new key#

3. Click on Try it#

4. Click on this icon#

5. Click on your-server-name variable to set your dynamic base URL.#

6. Here, you’ll need to replace these variables with their actual values.#

7. Paste the values you copied and saved.#

8. Click on Save & Exit#

9. Give the required parameters#

10. Click on Send#

11. The response from the API can be seen here#

Deleting API Key#

1. Click the Delete Key icon next to the key you want to remove#

2. Click on "Revoke"#

3. Confirmation popup message that the key has been deleted#

Developer Portal

Accessing the Developer Portal

1. Go to the Admin Panel from the sidebar.

2. Under Admin Panel in the Sidebar, Click on Settings

3. Click on API Keys

4. From here, copy your server URL, which you’ll need to pass as the baseURL when using the APIs.

5. From here, you can copy your auth token, which you’ll need to include in the header as a Bearer token when using the APIs.

Creating New API Key

1. Click on "Create new secret key"

2. Name your key in this field

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

4. Permission: All

5. Permission: Read Only

6. Permission: Restricted

7. Select Permission for each category

8. Click on Create

9. Click here to follow the link

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

11. Copy your secret key and click on Done.

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

Testing API Key in the REST API Playground

1. Click on View API documentation, you'll be redirected to Ejento APIs

2. Choose one of the endpoints to test your new key

3. Click on Try it

4. Click on this icon

5. Click on `your-server-name` variable to set your dynamic base URL.

6. Here, you’ll need to replace these variables with their actual values.

7. Paste the values you copied and saved.

8. Click on Save & Exit

9. Give the required parameters

10. Click on Send

11. The response from the API can be seen here

Deleting API Key

1. Click the Delete Key icon next to the key you want to remove

2. Click on "Revoke"

3. Confirmation popup message that the key has been deleted