Changes

Page history
Update OSDU API Quick start guide authored by Irakli Janiashvili's avatar Irakli Janiashvili
Hide whitespace changes
Inline Side-by-side
OSDU-API-Quick-start-guide.md
View page @ 746df466
...@@ -53,7 +53,7 @@ As a result, the _gcp-.postman_environment.json_ file should be downloaded. ...@@ -53,7 +53,7 @@ As a result, the _gcp-.postman_environment.json_ file should be downloaded.
![image001](uploads/55b6ba43691be1d8e651167decebbc1d/image001.png) ![image001](uploads/55b6ba43691be1d8e651167decebbc1d/image001.png)
<div>Image 1 – Cloud Function. Trigger URL</div>2. \\\*\\\*Download Postman\\\*\\\* <div>Image 1 – Cloud Function. Trigger URL</div>2. \\\\\\\*\\\\\\\*Download Postman\\\\\\\*\\\\\\\*
Download and install Postman (for example the [link](https://www.postman.com/downloads) may be used). Download and install Postman (for example the [link](https://www.postman.com/downloads) may be used).
...@@ -61,7 +61,7 @@ Download and install Postman (for example the [link](https://www.postman.com/dow ...@@ -61,7 +61,7 @@ Download and install Postman (for example the [link](https://www.postman.com/dow
![image003](uploads/921b240be55455b4fca5010337962ce1/image003.png) ![image003](uploads/921b240be55455b4fca5010337962ce1/image003.png)
<div>Image2 – Postman. Import of environment variables,</div>Import previously downloaded \\\_gcp-.postman_environment.json\\\_ to Postman Environments. <div>Image2 – Postman. Import of environment variables,</div>Import previously downloaded \\\\\\\_gcp-.postman_environment.json\\\\\\\_ to Postman Environments.
### Grant permissions for users ### Grant permissions for users
...@@ -83,7 +83,7 @@ The instruction for granting permissions is available by [the link](https://comm ...@@ -83,7 +83,7 @@ The instruction for granting permissions is available by [the link](https://comm
- Click on “OAuth 2.0 Configuration” icon and select “Use your own OAuth credentials” (image 3) ![image005](uploads/4c4e0f7a8f3d8af88fe949ec00d8be80/image005.png) - Click on “OAuth 2.0 Configuration” icon and select “Use your own OAuth credentials” (image 3) ![image005](uploads/4c4e0f7a8f3d8af88fe949ec00d8be80/image005.png)
- Ask “Owner” or “Viewer” of the GCP project where OSDU is deployed to create a client (Image 4) that is planned to use (API & Services -> Credentials -> OAuth 2.0 Client IDs) ![image007](uploads/3548c5785436951575a471cc04d05fd5/image007.png) - Ask “Owner” or “Viewer” of the GCP project where OSDU is deployed to create a client (Image 4) that is planned to use (API & Services -> Credentials -> OAuth 2.0 Client IDs) ![image007](uploads/3548c5785436951575a471cc04d05fd5/image007.png)
<div>Image 4. Adding a client</div>- Copy-paste CLIENT_ID and CLIENT_SECRET into the environmental variables in Postman (Image 5). Make sure you are updating both \\\*\\\*INITIAL VALUE\\\*\\\* and \\\*\\\*CURRENT VALUE\\\*\\\* ![image009](uploads/f984c539a3ade847147ad3872a171e7c/image009.png) <div>Image 4. Adding a client</div>- Copy-paste CLIENT_ID and CLIENT_SECRET into the environmental variables in Postman (Image 5). Make sure you are updating both \\\\\\\*\\\\\\\*INITIAL VALUE\\\\\\\*\\\\\\\* and \\\\\\\*\\\\\\\*CURRENT VALUE\\\\\\\*\\\\\\\* ![image009](uploads/f984c539a3ade847147ad3872a171e7c/image009.png)
<div>Image 5. Updating CLIEND_ID and CLIENT_SECRET in the Postman environment variables</div>- Click on the needed client and copy-paste CLIENT_ID and CLIENT_SECRET into the previous OAuth 2.0 Playground screen and click “Authorize APIs”. ![image011](uploads/8b0592b7bea223f84e20f9b0efdadf43/image011.png) <div>Image 5. Updating CLIEND_ID and CLIENT_SECRET in the Postman environment variables</div>- Click on the needed client and copy-paste CLIENT_ID and CLIENT_SECRET into the previous OAuth 2.0 Playground screen and click “Authorize APIs”. ![image011](uploads/8b0592b7bea223f84e20f9b0efdadf43/image011.png)
...@@ -91,7 +91,7 @@ The instruction for granting permissions is available by [the link](https://comm ...@@ -91,7 +91,7 @@ The instruction for granting permissions is available by [the link](https://comm
<div>Image 7.OAuth 2.0 Playground. Updating Client ID and Client Secret</div>- Select a user account that can be authorized on the next screen - Click “Exchange authorization code for tokens” (Image 8) ![image015](uploads/ea2fdfb596224d002bdfe460626595e7/image015.png) <div>Image 7.OAuth 2.0 Playground. Updating Client ID and Client Secret</div>- Select a user account that can be authorized on the next screen - Click “Exchange authorization code for tokens” (Image 8) ![image015](uploads/ea2fdfb596224d002bdfe460626595e7/image015.png)
<div>Image 8. OAuth 2.0 Playground. Exchange authorization code for tokens</div>- Copy refresh token into the Postman environment variables files (both \\\*\\\*INITIAL VALUE\\\*\\\* and \\\*\\\*CURRENT VALUE\\\*\\\*) (Image 9) ![image017](uploads/9d8496589ec9cd47da4833ac61e72745/image017.png) <div>Image 8. OAuth 2.0 Playground. Exchange authorization code for tokens</div>- Copy refresh token into the Postman environment variables files (both \\\\\\\*\\\\\\\*INITIAL VALUE\\\\\\\*\\\\\\\* and \\\\\\\*\\\\\\\*CURRENT VALUE\\\\\\\*\\\\\\\*) (Image 9) ![image017](uploads/9d8496589ec9cd47da4833ac61e72745/image017.png)
<div>Image 9.OAuth 2.0 Playground. Refresh token</div> <div>Image 9.OAuth 2.0 Playground. Refresh token</div>
...@@ -303,7 +303,7 @@ Metadata is described by the [JSON schemas](https://gitlab.opengroup.org/osdu/su ...@@ -303,7 +303,7 @@ Metadata is described by the [JSON schemas](https://gitlab.opengroup.org/osdu/su
![image019](uploads/68cf061e56f57e4106feadba00db5175/image019.png) ![image019](uploads/68cf061e56f57e4106feadba00db5175/image019.png)
<div>Image 10. Data (Files) ingestion \\\\\\\\ download</div>A user can choose 1 of 4 ways to upload data into OSDU. <div>Image 10. Data (Files) ingestion \\\\\\\\\\\\\\\\ download</div>A user can choose 1 of 4 ways to upload data into OSDU.
Let’s see how we can ingest Raster Well Log file in .tif format into OSDU. Please note that you can ingest a file of any format. Let’s see how we can ingest Raster Well Log file in .tif format into OSDU. Please note that you can ingest a file of any format.
...@@ -574,7 +574,7 @@ A mapping document between the .tif file and OSDU schema has to be created: ...@@ -574,7 +574,7 @@ A mapping document between the .tif file and OSDU schema has to be created:
![image035](uploads/fcada9d0bf68c088921f1d6bb0d9ef26/image035.png) ![image035](uploads/fcada9d0bf68c088921f1d6bb0d9ef26/image035.png)
<div>Image 16. A mapping document</div>\\\*\\\*Step 2. Create a manifest file\\\*\\\* <div>Image 16. A mapping document</div>\\\\\\\*\\\\\\\*Step 2. Create a manifest file\\\\\\\*\\\\\\\*
The structure of the manifest is described by [the OSDU Manifest schema](https://gitlab.opengroup.org/osdu/subcommittees/data-def/work-products/schema/-/blob/master/Generated/manifest/Manifest.1.0.0.json) The structure of the manifest is described by [the OSDU Manifest schema](https://gitlab.opengroup.org/osdu/subcommittees/data-def/work-products/schema/-/blob/master/Generated/manifest/Manifest.1.0.0.json)
...@@ -1022,7 +1022,7 @@ To review the log, please navigate to your Airflow console and open osdu_ingest ...@@ -1022,7 +1022,7 @@ To review the log, please navigate to your Airflow console and open osdu_ingest
![image043](uploads/f6a4424fa9f242856d02a2f2bf1d96d6/image043.png) ![image043](uploads/f6a4424fa9f242856d02a2f2bf1d96d6/image043.png)
<div>Image 21. Airflow. OSDU ingest DAG. XCom</div>\*\*Step 5. Check inserted data\*\* <div>Image 21. Airflow. OSDU ingest DAG. XCom</div>\\\*\\\*Step 5. Check inserted data\\\*\\\*
_Request:_ _Request:_
...@@ -1121,9 +1121,10 @@ GET {{FILE_HOST}}/files/{{record_id}}/downloadURL ...@@ -1121,9 +1121,10 @@ GET {{FILE_HOST}}/files/{{record_id}}/downloadURL
After executing this request simply download the file using the provided link. After executing this request simply download the file using the provided link.
Postman collection file: [OSDU_Quick_start.postman_collection.json](uploads/3c9820ad7dfe9ed873755c53500afe4e/OSDU_Quick_start.postman_collection.json)
#### Next steps #### Next steps
- [create OSDU on-prem using Helm chart](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-gcp-provisioning/-/blob/master/examples/simple_osdu_onprem/README.md) - [create OSDU on-prem using Helm chart](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-gcp-provisioning/-/blob/master/examples/simple_osdu_onprem/README.md)
- [create OSDU set of services within a single Google Cloud project](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-gcp-provisioning/-/blob/master/examples/simple_osdu/README.md) - [create OSDU set of services within a single Google Cloud project](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-gcp-provisioning/-/blob/master/examples/simple_osdu/README.md)
- [create OSDU set of service within Azure](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-azure-provisioning/-/blob/master/README.md) - [create OSDU set of service within Azure](https://community.opengroup.org/osdu/platform/deployment-and-operations/infra-azure-provisioning/-/blob/master/README.md)
\ No newline at end of file