Changes

Page history
Updated QSG with Config service info authored by Dzmitry Malkevich (EPAM)'s avatar Dzmitry Malkevich (EPAM)
Show whitespace changes
Inline Side-by-side
OSDU-API-Quick-start-guide.md
View page @ c4535750
...@@ -44,19 +44,14 @@ OSDU uses the Postman tool to do majority of API testing. Here are the pre-requi ...@@ -44,19 +44,14 @@ OSDU uses the Postman tool to do majority of API testing. Here are the pre-requi
_Pre-requisites:_ _Pre-requisites:_
1. Deployed OSDU on GCP deployed with [examples](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-gcp-provisioning/-/tree/release/0.15/examples/simple_osdu) (for release **M12/v0.15**) or newer ones 1. Deployed OSDU on GCP deployed with [examples](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-gcp-provisioning/-/tree/release/0.23/examples/simple_osdu) (for release **M20/v0.23**) or newer ones
2. A valid Google account that is used during OSDU deployment (used as the "admin_user_email" Terraform variable) 2. A valid Google account that is used during OSDU deployment (used as the "admin_user_email" Terraform variable)
_Steps:_ _Steps:_
1. **Download Postman environment file for the OSDU installation:** 1. **Download Postman environment file for the OSDU installation:**
- Login to the GCP console of your project
- Navigate to "Cloud Functions" > "postman-function-python" > "TRIGGER"
- Click on Trigger URL (image 1)
As a result, the _gcp-.postman_environment.json_ file should be downloaded. Since release M19/v0.22 GC installation comes with `config` service that allows download of Postman environment file. Simply use link `https://<your_domain>/api/config/v1/postman-environment` and save the page.
![Image 1 – Cloud Function. Trigger URL](uploads/55b6ba43691be1d8e651167decebbc1d/image001.png)
2. **Download Postman** 2. **Download Postman**
...@@ -99,7 +94,7 @@ Open [Quick start](https://community.opengroup.org/osdu/documentation/-/wikis/up ...@@ -99,7 +94,7 @@ Open [Quick start](https://community.opengroup.org/osdu/documentation/-/wikis/up
Verify that following variables are set in Postman enviroment and this environment is selected as active (use dropdown in top right corner): Verify that following variables are set in Postman enviroment and this environment is selected as active (use dropdown in top right corner):
```text ```text
callback_url=https://developers.google.com/oauthplayground callback_url=https://developers.google.com/oauthplayground
auth_url=https://accounts.google.com/o/oauth2/auth auth_url=accounts.google.com/o/oauth2/auth
Token_Fetch_URL=https://oauth2.googleapis.com/token Token_Fetch_URL=https://oauth2.googleapis.com/token
Scope=email openid profile Scope=email openid profile
``` ```
...@@ -111,10 +106,10 @@ Set ...@@ -111,10 +106,10 @@ Set
Token Name=<any name you like> Token Name=<any name you like>
Grant Type=Authorization Code Grant Type=Authorization Code
Callback URL={{callback_url}} Callback URL={{callback_url}}
Auth URL={{auth_url}}?access_type=offline&prompt=consent Auth URL=https://{{auth_url}}?access_type=offline&prompt=consent
Access Token URL={{Token_Fetch_URL}} Access Token URL={{Token_Fetch_URL}}
Client ID={{CLIENT_ID}} Client ID={{CLIENT_ID}}
Client Secret{{CLIENT_SECRET}} Client Secret={{CLIENT_SECRET}}
Scope={{Scope}} Scope={{Scope}}
``` ```
... ...
......