API-Dashboard

DevnagriAI · May 14, 2024 · 3a27b19 · 3a27b19
1 parent b20be36
commit 3a27b19
Show file tree

Hide file tree

Showing 15 changed files with 75 additions and 1 deletion.
diff --git a/.vuepress/config.js b/.vuepress/config.js
@@ -38,7 +38,8 @@ module.exports = {
             'Client_Guide',
             'Glossary',
             'Dota_web' ,
-            'Dota_mobile_app'
+            'Dota_mobile_app',
+            'API_Services'
           ]
         },
         {

diff --git a/guide/API_Services.md b/guide/API_Services.md
@@ -0,0 +1,73 @@
+# API Dashboard
+
+The API Dashboard guide offers a concise overview of the user journey, from enrolling in a plan to utilizing APIs.
+
+#### Subscribe to Devnagri API Services
+
+To subscribe to Devnagri API Services, one needs to click on the Subscribe APIs Button on the API Services tile.
+
+![DocumentOrder](./images/API_services_dashboard.png)
+
+Upon clicking "Subscribe APIs", user will be redirected to the API hub section, where one can select the API depending upon their requirements.
+
+![APIselection](./images/APIHub.png)
+
+Once the API is selected the user will be scrolled to the choice of plans available for the API.
+
+![PlanSelection](./images/APIHubPlan.png)
+
+#### Plans and their details:
+
+1. Free Plan : In this plan user has a word limit of 10,000 words and will only be able to create a single project key for the API
+
+2. Standard Plan : In this plan user will be charged at ₹ 0.10/word and will be allowed to generate multiple project keys for the APIs.
+
+Note: User needs to have a minimum balance of ₹ 1000, to make API requests.
+
+3. Premium Plan : This plan caters to Enterprise Customers, allowing for tailored quotes based on specific requirements.
+
+Once user selects any plan, will get a message similar to below one, and upon clicking on "Use API" will get redirected to creation of API credentials.
+
+![APIPlanSelection](./images/APIHubPlanEnroll.png)
+
+#### Creation of API credentials
+
+Once the user enrolls into a plan, one will be redirected to the credentials section where API key can be generated by clicking on Create button and mentioning the project name.
+
+![APIKeyCreation](./images/APICredentials.png)
+<br>
+
+![APIKeyDialog](./images/APIProjectName.png)
+
+User can create credentials by clicking on "Save" button, the API key will get displayed as partially hidden, and can be copied using the button corresponding to the key.
+
+![APICreds](./images/APICreds.png)
+
+Once the credentials are created user can move to API documentation to get the API curl requests and explore other options in the API requests.
+
+#### API Documentation
+
+User can move to API Documentation section post creation of API key. On the API Documentation page, user can select the API and then choose among the API key as per the choice of project.
+
+![APIDocumentation](./images/APIDoc.png)
+
+Users can select the API keys, and choose Source Languages and Target Languages from the dropdowns highlighted below.
+
+![APIDocumentation](./images/APIDocKey.png)
+
+The API Curl request and sample response are mentioned on the right side of the page, so that it becomes helpful for the developer while integrating the APIs.
+
+![APICurl](./images/APICurl.png)
+
+#### Overview
+
+The User can check the API request stats on the Overview page, which consists of number of API calls, and the number of words consumed.
+
+![APIOverview](./images/APIOverview.png)
+
+#### API Logs
+
+User can move to API Logs section for detailed usage, the logs section contains various filters like API type, Date Range filter for better analytics.
+
+![APILogs](./images/APILogs.png)
+
diff --git a/guide/images/APICredentials.png b/guide/images/APICredentials.png
diff --git a/guide/images/APICreds.png b/guide/images/APICreds.png
diff --git a/guide/images/APICurl.png b/guide/images/APICurl.png
diff --git a/guide/images/APIDoc.png b/guide/images/APIDoc.png
diff --git a/guide/images/APIDocKey.png b/guide/images/APIDocKey.png
diff --git a/guide/images/APIDocLang.png b/guide/images/APIDocLang.png
diff --git a/guide/images/APIHub.png b/guide/images/APIHub.png
diff --git a/guide/images/APIHubPlan.png b/guide/images/APIHubPlan.png
diff --git a/guide/images/APIHubPlanEnroll.png b/guide/images/APIHubPlanEnroll.png
diff --git a/guide/images/APILogs.png b/guide/images/APILogs.png
diff --git a/guide/images/APIOverview.png b/guide/images/APIOverview.png
diff --git a/guide/images/APIProjectName.png b/guide/images/APIProjectName.png
diff --git a/guide/images/API_services_dashboard.png b/guide/images/API_services_dashboard.png