Changes

Jump to navigation Jump to search
2,642 bytes added ,  15:34, 3 December 2019
no edit summary
Line 1: Line 1:  
<multilang>@en|
 
<multilang>@en|
   −
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.  
+
[[Earth_Observation_Data_Management_System_(EODMS)|EODMS]] has several options for API Access and automation i.e. Machine 2 Machine.  
 +
 
 +
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]
 +
 
 +
To find more GC APIs, visit the GC API site.  
    
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
 
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
 
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) ==
 
== OpenSearch API (for RADARSAT-1 and NAPL) ==
Line 14: Line 16:  
To form a get query it would take the form of:
 
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>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q={searchterms}</code>
    
e.g.:
 
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>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">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>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">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
 
SEARCH TERMS
   −
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
producttype which can be SCN,SGF, or SLC for Radarsat-1
 
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..
 
sensoroperationalmode which refers to the beam mnemonic like EH3, F1, W2, SCWB, SCNA etc..
Line 36: Line 38:  
The search terms can be used together with AND and OR. There is also support for wildcards, free text searching and other operators:
 
The search terms can be used together with AND and OR. There is also support for wildcards, free text searching and other operators:
   −
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
Wildcard Description
 
Wildcard Description
   Line 43: Line 45:  
</pre>
 
</pre>
   −
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
Operator Description
 
Operator Description
   Line 57: Line 59:  
== OGC APIs==
 
== OGC APIs==
   −
See [[File:EODMS OGC Services.pdf|none]] for complete details as well as an end-to-end sample.
+
The following is a complete end-to-end same to use OGC APIs
   −
=== CSW GetRecords ===
+
=== Discover some data / CSW GetRecords ===
    
URL (POST)
 
URL (POST)
   −
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog</code>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog</code>
    
HTTP POST - HEADER
 
HTTP POST - HEADER
   −
<pre><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results'  
+
<pre style="background-color:#EEFFCC; border-color:#AACC99"><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results'  
 
&#x09;outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2'  
 
&#x09;outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2'  
 
&#x09;xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2'  
 
&#x09;xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2'  
Line 81: Line 83:  
HTTP RESPONSE
 
HTTP RESPONSE
   −
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
<?xml version="1.0" encoding="UTF-8"?>  
 
<?xml version="1.0" encoding="UTF-8"?>  
 
<GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
 
<GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
Line 127: Line 129:  
</pre>
 
</pre>
   −
=== CSW GetRecordById ===
+
=== Fetch a Single Record / CSW GetRecordById ===
    
URL (GET REQUEST)
 
URL (GET REQUEST)
   −
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecordById&id=1515826&service=CSW&version=2.0.2</code>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">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
 
HTTP RESPONSE
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
 
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
 
&#x09;<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2"  
 
&#x09;<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2"  
Line 172: Line 174:  
</pre>
 
</pre>
   −
=== WCS DescribeCoverage ===
+
=== Order that Record / WCS DescribeCoverage ===
 +
 
 +
The WCS DescribeCoverage message is used for ordering and can be sent as a POST or GET (recommended) request.
    
URL (GET REQUEST)
 
URL (GET REQUEST)
   −
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=5117806&CollectionId=Radarsat1</code>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=5117806&CollectionId=Radarsat1</code>
    
URL (POST)
 
URL (POST)
   −
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs</code>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs</code>
    
HTTP POST - HEADER
 
HTTP POST - HEADER
   −
<pre><wcs:DescribeCoverage service="WCS" version="2.0.1"
+
<pre style="background-color:#EEFFCC; border-color:#AACC99"><wcs:DescribeCoverage service="WCS" version="2.0.1"
 
&#x09;xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 
&#x09;xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 
&#x09;xsi:schemaLocation="http://www.opengis.net/wcs/2.0
 
&#x09;xsi:schemaLocation="http://www.opengis.net/wcs/2.0
Line 195: Line 199:  
HTTP RESPONSE
 
HTTP RESPONSE
   −
<pre><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0">
+
<pre style="background-color:#EEFFCC; border-color:#AACC99"><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0">
 
&#x09;<wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2"  
 
&#x09;<wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2"  
 
&#x09;&#x09;gml:id="C380b242c-b324-4364-9ea5-7798f2f5e648">
 
&#x09;&#x09;gml:id="C380b242c-b324-4364-9ea5-7798f2f5e648">
Line 274: Line 278:  
</wcs:CoverageDescriptions></pre>
 
</wcs:CoverageDescriptions></pre>
   −
== Katalon ==
+
=== End-to-End OGC Order Example with Python ===
 +
 
 +
Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki open source Python module on GitHub] to search the EODMS_Catalog CSW and WCS services to order a Radarsat-1 image from the EODMS.
 +
 
 +
== Web Automation with Katalon ==
    
* A [https://github.com/nrcan-eodms-sgdot-rncan/eodms-scene-retriever Katalon utility] to automate website user clicks for searching and ordering.
 
* A [https://github.com/nrcan-eodms-sgdot-rncan/eodms-scene-retriever Katalon utility] to automate website user clicks for searching and ordering.
Line 280: Line 288:  
@fr|
 
@fr|
   −
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.
+
[[Earth_Observation_Data_Management_System_(EODMS)|SGDOT]] propose plusieurs options pour l’API Access et automation, à savoir Machine 2 Machine.  
 +
 
 +
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]
 +
 
 +
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]]
 
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
 
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) ==
 
== API OpenSearch (pour RADARSAT-1 et NAPL) ==
    
Pour former une requête get, cela prendrait la forme suivante:
 
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>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q={searchterms}</code>
    
Par exemple:
 
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>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">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>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">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
 
Termes de recherche
   −
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
producttype pouvant être SCN, SGF ou SLC pour Radarsat-1
 
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.
 
sensoroperationalmode qui fait référence à la mnémonique du faisceau comme EH3, F1, W2, SCWB, SCNA, etc.
Line 312: Line 322:  
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:
 
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>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
Wildcard Description
 
Wildcard Description
   Line 319: Line 329:  
</pre>
 
</pre>
   −
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
Operator Description
 
Operator Description
   Line 333: Line 343:  
== OGC ==
 
== OGC ==
   −
* API compatibles OGC: CSW pour la recherche et WCS pour la commande. Voir [[File:EODMS OGC Services.pdf|none]] pour plus d'informations.
+
* API compatibles OGC: CSW pour la recherche et WCS pour la commande.
   −
=== CSW GetRecords ===
+
=== Découvrez des images / CSW GetRecords ===
    
URL
 
URL
   −
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog</code>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog</code>
    
HTTP POST - HEADER
 
HTTP POST - HEADER
   −
<pre><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results'  
+
<pre style="background-color:#EEFFCC; border-color:#AACC99"><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results'  
 
&#x09;outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2'  
 
&#x09;outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2'  
 
&#x09;xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2'  
 
&#x09;xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2'  
Line 357: Line 367:  
HTTP RESPONSE
 
HTTP RESPONSE
   −
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
<?xml version="1.0" encoding="UTF-8"?>  
 
<?xml version="1.0" encoding="UTF-8"?>  
 
<GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
 
<GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
Line 399: Line 409:  
</pre>
 
</pre>
   −
=== CSW GetRecordById ===
+
=== Chercher une seule image / CSW GetRecordById ===
    
URL (GET REQUEST)
 
URL (GET REQUEST)
   −
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecordById&id=1515826&service=CSW&version=2.0.2</code>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">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
 
HTTP RESPONSE
<pre>
+
<pre style="background-color:#EEFFCC; border-color:#AACC99">
 
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
 
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
 
&#x09;<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2"  
 
&#x09;<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2"  
Line 442: Line 452:  
</pre>
 
</pre>
   −
=== WCS DescribeCoverage ===
+
=== Commandez cette image / WCS DescribeCoverage ===
 +
 
 +
Le message WCS DescribeCoverage est utilisé pour la commande et peut être envoyé sous forme de demande POST ou GET (recommandée).
    
URL (GET REQUEST)
 
URL (GET REQUEST)
   −
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=5117806&CollectionId=Radarsat1</code>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=5117806&CollectionId=Radarsat1</code>
    
URL (POST)
 
URL (POST)
   −
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs</code>
+
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs</code>
    
HTTP POST - HEADER
 
HTTP POST - HEADER
   −
<pre><wcs:DescribeCoverage service="WCS" version="2.0.1"
+
<pre style="background-color:#EEFFCC; border-color:#AACC99"><wcs:DescribeCoverage service="WCS" version="2.0.1"
 
&#x09;xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 
&#x09;xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 
&#x09;xsi:schemaLocation="http://www.opengis.net/wcs/2.0
 
&#x09;xsi:schemaLocation="http://www.opengis.net/wcs/2.0
Line 465: Line 477:  
HTTP RESPONSE
 
HTTP RESPONSE
   −
<pre><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0">
+
<pre style="background-color:#EEFFCC; border-color:#AACC99"><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0">
 
&#x09;<wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2"  
 
&#x09;<wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2"  
 
&#x09;&#x09;gml:id="C380b242c-b324-4364-9ea5-7798f2f5e648">
 
&#x09;&#x09;gml:id="C380b242c-b324-4364-9ea5-7798f2f5e648">
Line 544: Line 556:  
</wcs:CoverageDescriptions></pre>
 
</wcs:CoverageDescriptions></pre>
   −
== Katalon ==
+
=== Exemple de commande de bout en bout (avec Python) ===
 +
 
 +
Découvrez notre [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki module Python Open Source sur GitHub] pour rechercher les services EODMS_Catalog CSW et WCS afin de commander un Radarsat-1. image de l'EODMS.
 +
 
 +
== Automatisation web avec 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.
 
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>
 
</multilang>

Navigation menu

GCwiki