Skip to content

Commit

Permalink
Merge pull request #43 from unicef-drp/doc-update-enrolment-apikey
Browse files Browse the repository at this point in the history
Update enrolment via UI doc
  • Loading branch information
danangmassandy authored Aug 23, 2023
2 parents 02879d9 + 921da10 commit 565d2cf
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions docs/src/administrator/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ license: This program is free software; you can redistribute it and/or modify it
<!-- Narrative Instructions on how admin users will use the product/platform -->
<!-- Replace all of the titles with relevant titles -->

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

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/src/developer/api/guide/img/gen-api-key-1.png
Binary file not shown.
Binary file removed docs/src/developer/api/guide/img/gen-api-key-2.png
Binary file not shown.
Binary file removed docs/src/developer/api/guide/img/gen-api-key-3.png
Binary file not shown.
14 changes: 7 additions & 7 deletions docs/src/developer/api/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 565d2cf

Please sign in to comment.