Terradue API Documentation

This is the documentation for the Terradue API. The API is a RESTful API that is used to interact with the Terradue platform. The API is used to create and manage workspaces, catalogs, users, and other resources.

OpenAPI Specification

The API is described using the OpenAPI Specification at /v1/service.json.

The following tools can be used to interact with the API and to consume the OpenAPI Specification:

Swagger UI: /docs/swagger/index.html
ReDoc UI: /docs/redoc/index.html

Concepts

Identity and Access Management : TerrAPI is directly connected to the Terradue IAM service. It acts as a client of the IAM to manage resources through the authorization and authentication mechanisms provided by the IAM.
Platform : TerrAPI is a multi-platform API that can be used to manage resources on different deployments.
Resources : TerrAPI manages resources on the behalf of the user. The resources are organized in silos according to their functionality (Storage, Inventory, Registry and Production)
Services : TerrAPI provides with a set of services that can be used with the resources.

General concepts

Guides

This section contains a set of procedures to manage resources with the Terradue API.

As an application (Client) developer, you can use the Terradue API to manage resources on the Terradue platform. The following guides are available:

Request an Access Token as an Application : This guide explains how to request an access token to use the Terradue API as an application.
Exchange a User Access Token : This guide explains how to exchange a user access token from another application on the behalf of the user.