REST api

All the commands described in the following sections are provided using the comprehensive HTTP REST API of the platform.

Usage

Platform’s REST API endpoints can be invoked in any of the standard ways to invoke a RESTful API. Most of the following sections describe how to use the REST API using cURL or opensearch-client as an example.

Note

Using and Configuring cURL You can download cURL here. Learn how to use and configure cURL here.

Authentication

One of most important parameter to set in those REST commands is your API key which is configured in your profile page in the portal.

REST API supports two forms of authentication:

• Basic authentication using your username and password.
• Basic authentication using your username and API Key.

Routes

Routes are semantically important, especially in the case of searching in the catalogue.

https://catalog.terradue.com/mrossi/series/italy/search
`--------------------------´`------------------´`-----´
                |                  |               |
          service base url     resource        operation

The operation part can also be absent and the HTTP verb defines it. (e.g. POST for creation, PUT for update)

the following paragraphs summarize the different types of route of the platform

Data Agency - Catalogue service

https://catalog.terradue.com/<indexName>[/series/<seriesName>][/<operation>]

Data Agency - Storage service

https://store.terradue.com/<repoName>[/<folder>*]/<file>.<ext>