Difference between revisions of "Deleteme"

From wiki
Jump to navigation Jump to search
m (William.mackinnon moved page EODMS APIs to Deleteme)
 
(52 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<multilang>@en|
 
  
= EODMS APIs (and automation) =
 
 
EODMS is has several options for API Access and automation i.e. Machine 2 Machine. To find more GC APIs, visit the GC API site.
 
 
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
 
https://api.canada.ca/en/homepage
 
 
As part of the [https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=28108 Directive on Open Government], the Government of Canada is committed to improving its [https://twitter.com/hashtag/opendata?lang=en #OpenData] posture. EODMS API access aims to promote practices per the [https://www.canada.ca/en/government/system/digital-government/modern-emerging-technologies/government-canada-standards-apis.html GC Standards on APIs]
 
 
== OpenSearch API (for RADARSAT-1 and NAPL) ==
 
 
This OpenSearch API is the latest effort to align with giants like ESA and their [[https://scihub.copernicus.eu/userguide/OpenSearchAPI Copernicus Data Hub OpenSearch access program]] to improve RADARSAT-1 access
 
 
To form a get query it would take the form of:
 
 
<code>https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q={searchterms}</code>
 
 
e.g.:
 
 
<code>https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q=footprint:Intersects((-130.496,54.672))</code>
 
 
<pre>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]</pre>
 
 
SEARCH TERMS
 
 
<pre>
 
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)
 
</pre>
 
 
The search terms can be used together with AND and OR. There is also support for wildcards, free text searching and other operators:
 
 
<pre>
 
Wildcard Description
 
 
* any sequence of zero or more characters
 
? any one character
 
</pre>
 
 
<pre>
 
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.
 
</pre>
 
 
Heavily modeled after the ESA Data hubs so the following should apply:
 
<code>https://colhub.copernicus.eu/userguide/OpenSearchAPI</code>
 
 
== OGC APIs==
 
 
See [[File:EODMS OGC Services.pdf|none]] for complete details as well as an end-to-end sample.
 
 
=== CSW GetRecords ===
 
 
URL
 
 
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecords&service=CSW</code>
 
 
HTTP POST
 
 
<pre><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results' outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2' xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2' xmlns:ogc='http://www.opengis.net/ogc' xmlns:ows='http://www.opengis.net/ows' xmlns:dc='http://purl.org/dc/elements/1.1/' xmlns:dct='http://purl.org/dc/terms/' xmlns:gml='http://www.opengis.net/gml' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.opengis.net/cat/csw/2.0.2 http://schemas.opengis.net/csw/2.0.2/CSW-discovery.xsd'> <csw:Query typeNames='csw:Record'> <csw:ElementSetName typeNames='csw:Record'>summary</csw:ElementSetName> </csw:Query> </csw:GetRecords></pre>
 
 
HTTP RESPONSE
 
 
<pre>
 
<?xml version="1.0" encoding="UTF-8"?> <GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2"><SearchStatus timestamp="2018-08-28T01:59:38-04:00"/><SearchResults numberOfRecordsMatched="1949485" numberOfRecordsReturned="10" nextRecord="11">
 
<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2" xmlns:ows="http://www.opengis.net/ows" xmlns:dct="http://purl.org/dc/terms/" xmlns:dc="http://purl.org/dc/elements/1.1/"><dc:identifier>1511078</dc:identifier><dc:title>Radarsat-1 Raw Scenes</dc:title><dc:type>dataset</dc:type><dc:subject>Satellites, Imaging,Radar, Digital Collection, Mapping, Spatial Data, Remote Sensing</dc:subject><dc:subject>F1</dc:subject><dc:format>GeoTIFF</dc:format><dct:abstract>The Radarsat-1 satellite has a synthetic aperture radar(SAR) imaging instrument. The images are used internationally to manage and monitor the Earth's resources and to monitor global climate change, as well as in many other commercial and scientific applications. RADARSAT-1 is ideally suited to supporting these tasks because of its wide range of beams, SAR technology, frequent revisit period, high-quality products and fast, efficient delivery. Each of Radarsat-1's seven beam modes offer a different image resolution. The modes include Fine, which covers an area of 50 km × 50 km (31 mi × 31 mi) (2,500 km2 (970 sq mi)) with a resolution of 10 metres (33 ft); Standard, which
 
covers an area of 100 km × 100 km (62 mi × 62 mi) (10,000 km2 (3,900 sq mi)) and has a resolution of 30 metres (98 ft); and ScanSAR wide, which covers a 500 km × 500 km (310 mi × 310 mi) (250,000 km2 (97,000 sq mi)) area with a resolution of 100 metres (330 ft). Radarsat-1 also has the unique ability to direct its beam at different angles.</dct:abstract><ows:BoundingBox><ows:LowerCorner>32.664853 -3.055419</ows:LowerCorner><ows:UpperCorner>33.172058 -2.442097</ows:UpperCorner></ows:BoundingBox></csw:SummaryRecord>
 
...
 
</SearchResults>
 
</GetRecordsResponse>
 
</pre>
 
 
=== CSW GetRecordById ===
 
 
URL
 
 
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecordById&id=1515826&service=CSW&version=2.0.2</code>
 
 
HTTP RESPONSE
 
<pre>
 
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
 
<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2" xmlns:ows="http://www.opengis.net/ows" xmlns:dct="http://purl.org/dc/terms/" xmlns:dc="http://purl.org/dc/elements/1.1/">
 
<dc:identifier>1515826</dc:identifier>
 
<dc:title>Radarsat-1 Raw Scenes</dc:title>
 
<dc:type>dataset</dc:type>
 
<dc:subject>
 
Satellites, Imaging,Radar, Digital Collection, Mapping, Spatial Data, Remote Sensing
 
</dc:subject>
 
<dc:subject>F5</dc:subject>
 
<dc:format>GeoTIFF</dc:format>
 
<dct:abstract>
 
The Radarsat-1 satellite has a synthetic aperture radar(SAR) imaging instrument. The images are used internationally to manage and monitor the Earth's resources and to monitor global climate change, as well as in many other commercial and scientific applications. RADARSAT-1 is ideally suited to supporting these tasks because of its wide range of beams, SAR technology, frequent revisit period, high-quality products and fast, efficient delivery. Each of Radarsat-1's seven beam modes offer a different image resolution. The modes include Fine, which covers an area of 50 km × 50 km (31 mi × 31 mi) (2,500 km2 (970 sq mi)) with a resolution of 10 metres (33 ft); Standard, which covers an area of 100 km × 100 km (62 mi × 62 mi) (10,000 km2 (3,900 sq mi)) and has a resolution of 30 metres (98 ft); and ScanSAR wide, which covers a 500 km × 500 km (310 mi × 310 mi) (250,000 km2 (97,000 sq mi)) area with a resolution of 100 metres (330 ft). Radarsat-1 also has the unique ability to direct its beam at different angles.
 
</dct:abstract>
 
<ows:BoundingBox>
 
<ows:LowerCorner>-112.436916 40.41178</ows:LowerCorner>
 
<ows:UpperCorner>-111.769493 40.977687</ows:UpperCorner>
 
</ows:BoundingBox>
 
</csw:SummaryRecord>
 
</GetRecordByIdResponse>
 
</pre>
 
 
== Katalon ==
 
 
* A [https://github.com/nrcan-eodms-sgdot-rncan/eodms-scene-retriever Katalon utility] to automate website user clicks for searching and ordering.
 
 
@fr|
 
 
= Les API SGDOT =
 
 
SGDOT propose plusieurs options pour l’API Access et automation, à savoir Machine 2 Machine. Pour découvrir plus d’API du GC, visitez le site API du GC.
 
 
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
 
https://api.canada.ca/en/homepage
 
 
Dans le cadre de la [https://www.tbs-sct.gc.ca/pol/doc-fra.aspx?id=28108 Directive sur la gouvernance ouverte], le gouvernement du Canada s'est engagé à améliorer sa [https: // twitter.com/hashtag/opendata?lang=en #OpenData] posture. API EODMS [http://www.canada.ca/fr/government/system/digital-government/modern-emerging-technologies/government-canada-standards-apis.html Normes du GC sur les API]
 
 
== API OpenSearch (pour RADARSAT-1 et NAPL) ==
 
 
Pour former une requête get, cela prendrait la forme suivante:
 
<code>https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q={searchterms}</code>
 
 
Par exemple:
 
 
<code>https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q=footprint:Intersects((-130.496,54.672))</code>
 
 
<pre>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]</pre>
 
 
Termes de recherche
 
 
<pre>
 
producttype pouvant être SCN, SGF ou SLC pour Radarsat-1
 
sensoroperationalmode qui fait référence à la mnémonique du faisceau comme EH3, F1, W2, SCWB, SCNA, etc.
 
polarisationmode  qui n'est que HH pour R1
 
ingestiondate
 
beginposition
 
endposition
 
footprint  (point et polygon)
 
</pre>
 
 
Les termes de recherche peuvent être utilisés avec AND et OR. Il existe également un support pour les caractères génériques, la recherche de texte libre et d'autres opérateurs:
 
 
<pre>
 
Wildcard Description
 
 
* any sequence of zero or more characters
 
? any one character
 
</pre>
 
 
<pre>
 
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.
 
</pre>
 
 
Ainsi, comme indiqué précédemment, il est fortement calqué sur les concentrateurs de données ESA:
 
<code>https://colhub.copernicus.eu/userguide/OpenSearchAPI</code>
 
 
== OGC ==
 
 
* API compatibles OGC: CSW pour la recherche et WCS pour la commande. Voir [[File:EODMS OGC Services.pdf|none]] pour plus d'informations.
 
 
=== CSW GetRecords ===
 
 
URL
 
 
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecords&service=CSW</code>
 
 
HTTP POST
 
 
<pre><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results' outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2' xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2' xmlns:ogc='http://www.opengis.net/ogc' xmlns:ows='http://www.opengis.net/ows' xmlns:dc='http://purl.org/dc/elements/1.1/' xmlns:dct='http://purl.org/dc/terms/' xmlns:gml='http://www.opengis.net/gml' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.opengis.net/cat/csw/2.0.2 http://schemas.opengis.net/csw/2.0.2/CSW-discovery.xsd'> <csw:Query typeNames='csw:Record'> <csw:ElementSetName typeNames='csw:Record'>summary</csw:ElementSetName> </csw:Query> </csw:GetRecords></pre>
 
 
HTTP RESPONSE
 
 
<pre>
 
<?xml version="1.0" encoding="UTF-8"?> <GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2"><SearchStatus timestamp="2018-08-28T01:59:38-04:00"/><SearchResults numberOfRecordsMatched="1949485" numberOfRecordsReturned="10" nextRecord="11">
 
<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2" xmlns:ows="http://www.opengis.net/ows" xmlns:dct="http://purl.org/dc/terms/" xmlns:dc="http://purl.org/dc/elements/1.1/"><dc:identifier>1511078</dc:identifier><dc:title>Radarsat-1 Raw Scenes</dc:title><dc:type>dataset</dc:type><dc:subject>Satellites, Imaging,Radar, Digital Collection, Mapping, Spatial Data, Remote Sensing</dc:subject><dc:subject>F1</dc:subject><dc:format>GeoTIFF</dc:format><dct:abstract>The Radarsat-1 satellite has a synthetic aperture radar(SAR) imaging instrument. The images are used internationally to manage and monitor the Earth's resources and to monitor global climate change, as well as in many other commercial and scientific applications. RADARSAT-1 is ideally suited to supporting these tasks because of its wide range of beams, SAR technology, frequent revisit period, high-quality products and fast, efficient delivery. Each of Radarsat-1's seven beam modes offer a different image resolution. The modes include Fine, which covers an area of 50 km × 50 km (31 mi × 31 mi) (2,500 km2 (970 sq mi)) with a resolution of 10 metres (33 ft); Standard, which
 
covers an area of 100 km × 100 km (62 mi × 62 mi) (10,000 km2 (3,900 sq mi)) and has a resolution of 30 metres (98 ft); and ScanSAR wide, which covers a 500 km × 500 km (310 mi × 310 mi) (250,000 km2 (97,000 sq mi)) area with a resolution of 100 metres (330 ft). Radarsat-1 also has the unique ability to direct its beam at different angles.</dct:abstract><ows:BoundingBox><ows:LowerCorner>32.664853 -3.055419</ows:LowerCorner><ows:UpperCorner>33.172058 -2.442097</ows:UpperCorner></ows:BoundingBox></csw:SummaryRecord>
 
...
 
</SearchResults>
 
</GetRecordsResponse>
 
</pre>
 
 
=== CSW GetRecordById ===
 
 
URL
 
 
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecordById&id=1515826&service=CSW&version=2.0.2</code>
 
 
HTTP RESPONSE
 
<pre>
 
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
 
<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2" xmlns:ows="http://www.opengis.net/ows" xmlns:dct="http://purl.org/dc/terms/" xmlns:dc="http://purl.org/dc/elements/1.1/">
 
<dc:identifier>1515826</dc:identifier>
 
<dc:title>Radarsat-1 Raw Scenes</dc:title>
 
<dc:type>dataset</dc:type>
 
<dc:subject>
 
Satellites, Imaging,Radar, Digital Collection, Mapping, Spatial Data, Remote Sensing
 
</dc:subject>
 
<dc:subject>F5</dc:subject>
 
<dc:format>GeoTIFF</dc:format>
 
<dct:abstract>
 
The Radarsat-1 satellite has a synthetic aperture radar(SAR) imaging instrument. The images are used internationally to manage and monitor the Earth's resources and to monitor global climate change, as well as in many other commercial and scientific applications. RADARSAT-1 is ideally suited to supporting these tasks because of its wide range of beams, SAR technology, frequent revisit period, high-quality products and fast, efficient delivery. Each of Radarsat-1's seven beam modes offer a different image resolution. The modes include Fine, which covers an area of 50 km × 50 km (31 mi × 31 mi) (2,500 km2 (970 sq mi)) with a resolution of 10 metres (33 ft); Standard, which covers an area of 100 km × 100 km (62 mi × 62 mi) (10,000 km2 (3,900 sq mi)) and has a resolution of 30 metres (98 ft); and ScanSAR wide, which covers a 500 km × 500 km (310 mi × 310 mi) (250,000 km2 (97,000 sq mi)) area with a resolution of 100 metres (330 ft). Radarsat-1 also has the unique ability to direct its beam at different angles.
 
</dct:abstract>
 
<ows:BoundingBox>
 
<ows:LowerCorner>-112.436916 40.41178</ows:LowerCorner>
 
<ows:UpperCorner>-111.769493 40.977687</ows:UpperCorner>
 
</ows:BoundingBox>
 
</csw:SummaryRecord>
 
</GetRecordByIdResponse>
 
</pre>
 
 
== Katalon ==
 
 
Un [https://github.com/nrcan-eodms-sgdot-rncan/eodms-scene-retriever Outil Katalon] pour automatiser les clics de l'utilisateur du site Web pour la recherche et la commande.
 
 
</multilang>
 

Latest revision as of 19:05, 6 January 2022