Skip to content

Commit

Permalink
more changes in api dashboard
Browse files Browse the repository at this point in the history
  • Loading branch information
jaspreet12d authored and jaspreet12d committed May 16, 2024
1 parent 4c64f8e commit e32afe6
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions guide/API_Services.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,66 +8,66 @@ Click on the Subscribe API button in the API Services tile to subscribe.

![DocumentOrder](./images/API_services_dashboard.png)

Post clicking, the user will be redirected to the API Hub section to select the specific API depending upon their requirements.
Select the specific API depending on the requirements from the API Hub section.

![APIselection](./images/APIHub.png)

Post the API selection, choose one of the plans as per requirement.
Choose one of the plans as per requirement.

![PlanSelection](./images/APIHubPlan.png)

#### Plans and their details:

1. Free Plan : Word limit of 10,000 words and restriction of being able to create a single project key for API usage.
1. Free Plan : Word limit of 10,000 words and restriction of being able to create only a single project key for API usage.

2. Standard Plan : Charged at ₹ 0.10/word and option to generate multiple project keys for APIs.
2. Standard Plan : Charged at ₹ 0.10/word with option to generate multiple project keys for APIs.

Note: Minimum balance of ₹ 1000 needed to make API requests.
Note: Minimum balance of ₹ 1000/- needed to make API requests.

3. Premium Plan : Primarily catering to Enterprise Customers and allows for customised quotes based on specific requirements. Plus, a dedicated account manager to help you during the integration phase.
3. Premium Plan : Primarily catering to Enterprise customers with customised quotes based on specific requirements. Plus, a dedicated account manager during the integration phase.

Post selection of a plan, the user will get redirected to a page to help in creation of API credentials.
Post plan selection, the user will get redirected to a page to help in creation of API credentials.

![APIPlanSelection](./images/APIHubPlanEnroll.png)

#### Creation of API credentials

API key can be generated by clicking on Create button and mentioning the project name.
API key can be generated by clicking on the Create button and do remember to mention the project name.

![APIKeyCreation](./images/APICredentials.png)
<br>

![APIKeyDialog](./images/APIProjectName.png)

Post clicking the Save button, the API key will be displayed as partially hidden on the screen. However, the complete key gets copied using the copy button.
Post Save, the API key will be displayed as partially hidden on the screen. However, the complete key gets copied using the copy button.

![APICreds](./images/APICreds.png)

Post the credentials, the user can move to API documentation to get the API curl requests and explore other options in the API requests.

#### API Documentation

Select the API and choose amongst the API keys as per the specific projects.
Select the API and choose amongst the API keys as per the project.

![APIDocumentation](./images/APIDoc.png)

Select the API key and choose the Source and Target Languages from the dropdowns highlighted below.
Select the API key and choose the Source and Target Language from the dropdowns highlighted below.

![APIDocumentation](./images/APIDocKey.png)

To help ease the API integration, the API curl request and sample response are mentioned on the right side of the page.
To help ease the API integration, the API curl request and sample response are displayed on the right side of the page.

![APICurl](./images/APICurl.png)

#### Overview

Check the API request stats on the Overview page. It shows the number of API calls and the number of words consumed.
Check the API request stats on the Overview page to see the number of API calls made and the number of words consumed.

![APIOverview](./images/APIOverview.png)

#### API Logs

This section shows the detailed usage. Filters on API type, Date Range etc can help for better analytics at customer end.
For detailed logs including filters on API type, Date Range to help in better, detailed analytics at customer end.

![APILogs](./images/APILogs.png)

0 comments on commit e32afe6

Please sign in to comment.