Difference between revisions of "Deleteme"
Line 12: | Line 12: | ||
== Python Package == | == Python Package == | ||
− | For any Python developers, we also have a [https://pypi.org/project/py-eodms-rapi/ Python package used to access the | + | For any Python developers, we also have a [https://pypi.org/project/py-eodms-rapi/ Python package used to access the REST API]. To learn how to use the package, visit [https://py-eodms-rapi.readthedocs.io/en/latest/]. |
== REST API == | == REST API == |
Revision as of 10:49, 7 September 2021
Overview
EODMS has several options for search and download API access as well as automation i.e. Machine 2 Machine. As part of the Directive on Open Government, the Government of Canada is committed to improving its #OpenData posture. EODMS API access aims to promote practices per the GC Standards on APIs. To find more GC APIs, visit the GC API site
GitHub Repo - Search and Download in Python
Checkout out our REST API client and OGC API client Python repos on GitHub which automate the search and download of images from EODMS.
Python Package
For any Python developers, we also have a Python package used to access the REST API. To learn how to use the package, visit [1].
REST API
Visit [2] to find out more about our client to search and download images. To access the REST API directly, see [3].
OPENSEARCH API
OPENSEARCH Search
To see a list of collection names open to GUEST users to supply to the collection query string argument visit: https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/collections
BASIC
https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/opensearch/search?collection=Radarsat1&q=*
SPATIAL
https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/opensearch/search?collection=NAPL&q=*&bbox=-75.71,45.42,-75.69,45.43
OPENSEARCH Order
Using a RESPONSE from the OPENSEARCH Search, you can parse out the collectionId
and recordId
and submit a corresponding REST Order. e.g. collectionId=Radarsat1
and recordId=1508207
OPENSEARCH API. Copernicus Hub Inspired. Provides Direct Download. RADARSAT-1 and NAPL, ONLY)
This particular flavour of OpenSearch API is heavily modeled after the [Copernicus Data Hub OpenSearch access program] to align RADARSAT-1 and NAPL access with SENTINEL access. Each API response comes with a direct download URL (in contrast to the REST Order API call which invokes a slower archive-pull-and-stage operation.
QUERY FORMAT
https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q={searchterms}
QUERY EXAMPLES
https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q=beginposition:[2007-08-20T00:49:50Z%20TO%202007-08-22T10:50:50Z]
SEARCH TERMS
producttype which can be SCN,SGF, or SLC for Radarsat-1 sensoroperationalmode which refers to the beam mnemonic like EH3, F1, W2, SCWB, SCNA etc.. polarisationmode which is only HH for R1 ingestiondate beginposition endposition footprint (point and polygon)
The search terms can be used together with AND and OR. There is also support for wildcards, free text searching and other operators:
Wildcard Description * any sequence of zero or more characters ? any one character
Operator Description AND Narrow search and retrieve records containing all of the words it separates. OR Broaden search and retrieve records containing any of the words it separates. NOT Narrow search and retrieve records that do not contain the term following it. ( ) Group words or phrases when combining Boolean phrases and to show the order in which relationships should be considered.
Heavily modeled after the ESA Data hubs so the following should apply:
https://colhub.copernicus.eu/userguide/OpenSearchAPI
OGC APIs
To use The following are usage samples of EODMS' OGC APIs with a fully open source Python client on GitHub. To find out how to access the OGC APIs directly visit repo's wiki page
Github Repo - Web Automation with Katalon
- A Katalon utility to automate website user clicks for searching and ordering.