diff --git a/docs/src/administrator/guide/index.md b/docs/src/administrator/guide/index.md index 318d1fc6..bad4cffe 100644 --- a/docs/src/administrator/guide/index.md +++ b/docs/src/administrator/guide/index.md @@ -15,21 +15,21 @@ license: This program is free software; you can redistribute it and/or modify it -## How to Add GeoSight API Keys to Dataset Permission +## How to Add GeoSight API Keys to Dataset Permissions -Go to the dataset listing page and click on one of the dataset. +Go to the dataset listing page and click on one of the datasets. ![](./img/gs-api-key-1.png) -Go to the Permission > User tab and click on the `Add User` button. +Go to the Permission Tab then to the User tab and click on the `Add User` button. ![](./img/gs-api-key-2.png) -For API Key Level 4, select a **API_KEY GeoSight_lv_4 (Viewer)** as the User, **Read** permission, and privacy level **4 - Highly confidential**. Click on the `Save` button to add the permission. +For a Level 4 API Key, select **API_KEY GeoSight_lv_4 (Viewer)** as the User, **Read** as the Permission, and a Privacy Level of **4 - Highly confidential**. Click on the `Save` button to add the permission. ![](./img/gs-api-key-3.png) -For API Key Level 1, select a **API_KEY GeoSight_lv_1 (Viewer)** as the User, **Read** permission, and privacy level **1 - Publicly shareable**. Click on the `Save` button to add the permission. +For a Level 1 API Key, select **API_KEY GeoSight_lv_1 (Viewer)** as the User, **Read** as the Permission, and a Privacy Level of **1 - Publicly shareable**. Click on the `Save` button to add the permission. ![](./img/gs-api-key-4.png) diff --git a/docs/src/developer/api/guide/img/enrol-api-key-1.png b/docs/src/developer/api/guide/img/enrol-api-key-1.png new file mode 100644 index 00000000..8bc62dd7 Binary files /dev/null and b/docs/src/developer/api/guide/img/enrol-api-key-1.png differ diff --git a/docs/src/developer/api/guide/img/enrol-api-key-2.png b/docs/src/developer/api/guide/img/enrol-api-key-2.png new file mode 100644 index 00000000..eca8edb6 Binary files /dev/null and b/docs/src/developer/api/guide/img/enrol-api-key-2.png differ diff --git a/docs/src/developer/api/guide/img/enrol-api-key-3.png b/docs/src/developer/api/guide/img/enrol-api-key-3.png new file mode 100644 index 00000000..ab2a658d Binary files /dev/null and b/docs/src/developer/api/guide/img/enrol-api-key-3.png differ diff --git a/docs/src/developer/api/guide/img/gen-api-key-1.png b/docs/src/developer/api/guide/img/gen-api-key-1.png deleted file mode 100644 index ce51b5cd..00000000 Binary files a/docs/src/developer/api/guide/img/gen-api-key-1.png and /dev/null differ diff --git a/docs/src/developer/api/guide/img/gen-api-key-2.png b/docs/src/developer/api/guide/img/gen-api-key-2.png deleted file mode 100644 index 7b93ed60..00000000 Binary files a/docs/src/developer/api/guide/img/gen-api-key-2.png and /dev/null differ diff --git a/docs/src/developer/api/guide/img/gen-api-key-3.png b/docs/src/developer/api/guide/img/gen-api-key-3.png deleted file mode 100644 index ceb18f5a..00000000 Binary files a/docs/src/developer/api/guide/img/gen-api-key-3.png and /dev/null differ diff --git a/docs/src/developer/api/guide/index.md b/docs/src/developer/api/guide/index.md index 2901caf0..3a438cff 100644 --- a/docs/src/developer/api/guide/index.md +++ b/docs/src/developer/api/guide/index.md @@ -93,18 +93,18 @@ to the discovery of geographical entities. ### Generating an API KEY -Go to the Django Administration Page > Core > API Keys. Click on the `Add API Key` button. +Go to the Profile page and click on the `API KEY ENROLMENT` tab. -![](./img/gen-api-key-1.png) +![](./img/enrol-api-key-1.png) -Select a **User** and fill in the other details (Platform, Owner, and Contact). -Click the `Save` button to create the API Key. +Fill in the details (Platform, Owner, and Contact) and click on the `Generate API Key` button. +Click on the `Confirm` button in the confirmation dialog. -![](./img/gen-api-key-2.png) +![](./img/enrol-api-key-2.png) -Copy the generated key to be used in your application codes. +Click on `icon 1️⃣` to see the generated API key or click on `icon 2️⃣` to copy the API key to the clipboard. The `Revoke` button can deactivate the API key so that the API key cannot be used without needing to remove it from the system. The `Delete API Key` button will remove the API key from the system. -![](./img/gen-api-key-3.png) +![](./img/enrol-api-key-3.png) ## Examples of usage of the API