Language
How to use it
  1. ExtenSo Service features
    1. Available Collections
    2. Available Sources
    3. extenSO FREE User
    4. Why extenSO API ?
    5. Getting Started
      1. 1. Authentication
      2. 2. Import Collections and Environement in Postman
      3. 3. Create the list of Product Ids that you want
      4. 4. Using The extenSO API
    6. Downloading Ordered Products
    7. Known Limitations

extenSO API V3.0.0

extenso Service features:

  • A single interface to download the whole spectrum of Copernicus Products.
  • Estimate the necessary storage required by an order.
  • Search for Products Metadata (bêta).
  • Search for Products Ids by criterias.
  • Download Products Quicklook and Thumbnail.

Available Collections :

  • S1, S2, S3 and S5P are currently available.
  • We plan to add other sources of data than Copernicus.

Available Sources :

  • Sobloo and Copernicus Data Hub are currently available (Diashub1).

extenSO FREE User :

  • You can use all the services
  • If you need more storage on contact us

Why extenSO API ?

  • Get the products directly inside your bucket : The Sources and APIs of each service are constantly evolving. It takes time to create and maintain scripts that allows you to download from different sources.
  • Solve Sources Problems : The differents Data Providers have many problems (offline services for days, download errors, products are missing, etc.). With extenSO API, if some errors occurs, further attempts tp download will be automaticly executed, you do not need to worry.
  • Long Term Archives are hard to handle : When you want to warmup a product stored in cold storage it can take up to two days for it to be downloadable. The extenSO Api will trigger the warmup and download it automaticly into your bucket.
  • Too many APIs with differents collections : With the extenSO API you can access products from Sobloo, Copernicus Data Hub to cover the main collections and products.
  • Avoid Free User Limitations : The Copernicus Data Hub (SciHub) allows you to download only two products in parallel and 20 warmup request every 12h. By using extenSO, you bypass this constraint and get onto our larger bandwidth.
  • Avoid collection limitations : Sources other than the SciHub (limited in bandwidth) only store partial products from some collections. When using extenSO and Sobloo, you can get the whole spectrum.

Getting Started

1. Authentication

Same as OneAtlas Authentication

2. Import Collections and Environement in Postman

3. Create the list of Product Ids that you want

  • The catalog works thanks to several public reference catalogs.
  • For each collection the reference catalog is :
  • Sentinel-1 (S1) : sci-hub
  • Sentinel-2 (S2) : sci-hub
  • Sentinel-3 (S3) : sci-hub
  • Sentinel-5P (S5P) : s5p-hub

S1, S2 or S3 products : Create a list of products via sci-hub

Note: You can find default queries in the Postman folder : / Search (Products, Quicklooks, Thumbnails) / Referential Catalogs (S1, S2, S3 and S5) / sci-hub (S1, S2, S3)

  • From Referential Catalogs endpoints, select the right query depending of produtcs type you want to search (S1, S2 or S3) :

Note: API endpoints are aggregated by data collection. So, for example, if you use S1 endpoint, you will be able to retreive only S1 products. A combined query to search S1 + S2 product will not work.

quicklook

  • Then, you can adjust query params according to the relevant reference catalog.

quicklook

  • One you get the result with all the metadata, select all the query params after the ? and copy them.

quicklook

  • Then, open the Search Products Ids on Referential Catalogs endpoints, choose your query and replace the query params at the end of the query by the query params previously copied. Send the query, you will see all the products displayed in result body.

quicklook

Example of list containing one S1, one S2 and one S3 product :

["S1A_IW_SLC__1SDV_20141111T171403_20141111T171421_003237_003BC8_1216","S2A_MSIL1C_20161206T080312_N0204_
R035_T36NVH_20161206T081415","S3A_SL_1_RBT____20160705T034516_20160705T034816_20181001T213155_0179_006_09
0______LR1_R_NT_003"]

S5P products : Create a list of products via s5p-hub

  • Use the default user : “s5pguest” and password : “s5phub”. They are already filled in the extenSO postman environment.
  • Go to API Documentation to create your query.

Note: You can find default queries in the Postman folder : / Search (Products, Quicklooks, Thumbnails) / Referential Catalogs (S1, S2, S3 and S5P) / s5p-hub (S5P).

quicklook

  • Process is exactly the same as previously, just select the following collection.

Example of list containing one S5P product :

["S1A_IW_SLC__1SDV_20141111T171403_20141111T171421_003237_003BC8_1216","S2A_MSIL1C_20161206T080312_N0204_
R035_T36NVH_20161206T081415","S3A_SL_1_RBT____20160705T034516_20160705T034816_20181001T213155_0179_006_09
0______LR1_R_NT_003"]

4. Using The extenSO API

There are 5 folders that contain several request examples. Here below a summary of the available features by folder.


4.0. Login (Choose the method you want) : You can login via One Atlas or Sobloo.


ActionMethodEndpointHeaderBody
Login via One AtlasPOSThttps://authenticate.foundation.api.oneatlas.airbus.com/auth/realms/IDP/protocol/openid-connect/tokenContent-Type=application/x-www-form-urlencodedapikey=<API_KEY_ONE_ATLAS>&grant_type=api_key&client_id=IDP
Login via SoblooPOSThttps://authenticate.sobloo.eu/auth/realms/IDP/protocol/openid-connect/tokenContent-Type=application/x-www-form-urlencodedapikey=<API_KEY_SOBLOO>&grant_type=api_key&client_id=IDP


4.1. Search (Products, Quicklooks, Thumbnails) : Get Products Metadata, Quicklooks and Thumbnails from different sources.


ActionMethodEndpointQueryParams/BodyExemple
Search Products Ids via Referential Catalogs (S1, S2, S3 and S5)GET/api/v1/services/extended-search/products/{collection}/?q=?You can find documentation for S1, S2 and S3 here and for S5p here
(beta) Search Products Metadata from Ids (S1, S2, S3 and S5)POST/api/v1/services/extended-search/productsA list of product Ids.[“S1AIW…”,“S1B…”, “S1AIW_…”]
Search Quicklooks (S1, S2 and S3)GET/api/v1/services/extended-search/products/quicklook/{productId}
Search Thumbnails (S1, S2 and S3)GET/api/v1/services/extended-search/products/thumbnail/{productId}

4.2. Order (Download Products in My Storage) : Download Products in my Storage.


ActionMethodEndpointBodyBody Exemple
Estimate (Volume of an Order)POST/api/v1/services/order/products/estimateA list of product Ids{“products”: [“S1AWV…”]}
Create Order (Download a list of products in my dedicated bucket)POST/api/v1/services/order/products/ordersA list of product Ids.{“products”: [“S1AWV…”]}
Get all OrdersGET/api/v1/services/order/products/orders
Get Order by IdGET/api/v1/services/order/products/orders/{orderId}
Get all Deliveries (Products ordered)GET/api/v1/services/order/products/deliveries
Get all Deliveries by OrderGET/api/v1/services/order/products/orders/{orderId}/deliveries
Get Delivery by idGET/api/v1/services/order/products/orders/{orderId}/deliveries/{deliveryId}

4.3. My Storage (Download Products and Manage your Storage) : Retrieve downloaded data and manage your storage space.


ActionMethodEndpoint
Delete Order by Id and all the products from My StorageDELETE/api/v1/services/user-storage/products/orders/{orderId}
Download Delivery (Redirect to presigned download url)GET/api/v1/services/user-storage/products/orders/{orderId}/deliveries/{deliveryId}/download
Get Delivery Download Url (If the redirection is not possible)GET/api/v1/services/user-storage/products/orders/{orderId}/deliveries/{deliveryId}/download-url
Get Delivery Metadata.GET/api/v1/services/user-storage/products/orders/{orderId}/deliveries/{deliveryId}/metadata

Note: The download from postman will fail because of the size of the products. You can use Curl in version v7.58+. See next chapter for Downloading Ordered Products.

4.4. My Account (Manage your Account) : User informations and registration

ActionMethodEndpoint
Get *Personal Informations *(Storage status…)GETapi/v1/services/user-storage/me

Downloading Ordered Products

  • When your order has delivered products, you can download the products onto your machine.
  • Get a delivery id (cf. Get all Deliveries by Order) then execute these commands :

Solution 1 : You can download from extenSO : Requirement : Curl version v7.58+

curl --location --request GET https://sobloo.eu/api/v1/services/user-
storage/products/orders/<YOUR_ORDER_ID>/deliveries/<YOUR_DELIVERY_ID>/download --header "Authorization:
Apikey <YOUR_API_KEY>" --output product.zip

Solution 2 : You can download directly from the cloud provider :

curl --location --request GET https://sobloo.eu/api/v1/services/user-
storage/products/orders/<YOUR_ORDER_ID>/deliveries/<YOUR_DELIVERY_ID>/download-url --header
"Authorization: Apikey <YOUR_API_KEY>"
curl --location --request GET "<THE_DOWNLOAD_LINK>" --output product.zip

Known Limitations

Download

Contact Us