Language
In this Tutorial
  1. Explore & Access Living Library
    1. Authenticate
    2. Check your subscription
    3. Search & Order
      1. Search for images
      2. View Quicklook
      3. Access images in streaming
      4. Check your balance
      5. Calculate the price of the image
      6. Order your product
    4. Follow-up your order
    5. Download an image

Explore & Access Living Library

This page contains step-by-step tutorials designed to help you learn how to master our APIs. We will walk you through the key Living Library functionalities that OneAtlas Data has to offer, including authenticating, searching and ordering. Living Library simply refers to our real time collection of high resolution constellation imagery. Lets dive straight into the tutorial!

Authenticate

Before you can get started, you first need the key to open the door to our APIs! You can get your API Key by signing into your OneAtlas account and using our API Key Generator. Make sure to keep this safe, you will need this in the next step.

Don’t yet have a OneAtlas Account? Feel free to contact us via our main OneAtlas page.

Next you need to use the /auth/realms/IDP/protocol/openid-connect/token endpoint, replacing your API key which you have generated before.

curl -X POST \
  https://authenticate.foundation.api.oneatlas.airbus.com/auth/realms/IDP/protocol/openid-connect/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'apikey=<api_key>&grant_type=api_key&client_id=IDP'

var data = "apikey=<api_key>&grant_type=api_key&client_id=IDP";

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://authenticate.foundation.api.oneatlas.airbus.com/auth/realms/IDP/protocol/openid-connect/token");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = [
  ('apikey', '<api_key>'),
  ('grant_type', 'api_key'),
  ('client_id', 'IDP'),
]

response = requests.post('https://authenticate.foundation.api.oneatlas.airbus.com/auth/realms/IDP/protocol/openid-connect/token', headers=headers, data=data)

print(response.text)

You will be provided with an access token:

{
    "access_token": "<access_token>",
    "expires_in": 3600,
    "refresh_expires_in": 0,
    "token_type": "bearer"
}

Check your subscription

You should have successfully authenticated and retrieved the status of the server. In order to access OneAtlas streaming capabilities you will require a streaming plan. The types of streaming plans we offer are displayed below:

Streaming PlanDescription
discoverIncludes the right to stream 1 GB
starterIncludes the right to stream 4 GB
standardIncludes the right to stream 10 GB
advancedIncludes the right to stream 30 GB

Do you want to try our service for 1 month free? You can register for a free trial on our OneAtlas page.

To get information about your user including payments and subscriptions, use the endpoint /api/v1/me:

curl -X GET \
  https://data.api.oneatlas.airbus.com/api/v1/me \
  -H 'Authorization: Bearer <access_token>'

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/me");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/me"

headers = {
    'Authorization': "Bearer <access_token>",
    'Cache-Control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

This will return multiple data relating to your contract:

{
    "_links": {
        "self": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/me"
        },
        "licenses": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/licenseAgreements"
        }
    },
    "id": "bf3d937a-e846-446a-e5b6-0a26227b892f",
    "status": "created",
    "createdAt": "2018-04-30T08:51:43.393720+00:00",
    "roles": [
        "user",
    ],
    "contract": {
        "_links": {
            "self": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083"
            },
            "orders": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/orders"
            },
            "payments": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/payments"
            },
            "subscriptions": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/subscriptions"
            },
             "deliveries": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/deliveries"
            },
            "reports": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/reports"
            }
        },
        "id": "8b273bd7-5626-4ef3-80cf-c4fc33191083",
        "status": "created",
        "createdAt": "2018-06-11T09:23:01.868510+00:00",
        "offers": [
            "order.product",
            "order.subscription.change-detection",
            "order.subscription.streaming"
        ],
        "kind": "contract.change-detection",
        "name": "airbus guide",
        "balance": 1341,
        "workspaceId": "148eebbd-a9b9-4cf6-97d3-87237901a7b9"
    }
}

From here you can access information relating to your subscription using your subscription url shown above:

curl -X GET \
  https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id}/subscriptions \
  -H 'Authorization: Bearer <access_token>'

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id}/subscriptions");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

import requests

url = "https://data.api.oneatlas.airbus.com/api/v1/contracts/{contract_id}/subscriptions"

headers = {
    'Authorization': "Bearer <access_token>",
    'Cache-Control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

{
    "startIndex": 0,
    "totalResults": 5,
    "itemsPerPage": 10,
    "items": [
        {
            "_links": {
                "self": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },
                 "contract": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
                },
                 "reports": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/0b9da7d1-5b21-4532-84db-fd8b399ec47e/reports"
                },
                 "deliveries": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/deliveries?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },
                "payments": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/payments?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },
                 "orders": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/orders?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                }
            },
            "id": "0b9da7d1-5b21-4532-84db-fd8b399ec47e",
            "status": "active",
            "startedAt": "2019-02-07T16:47:56.272827+00:00",
            "endedAt": "2019-12-01T00:00:00+00:00",
            "service": "data",
            "isAmountEstimated": "true",
            "kind": "subscription.oneatlas",
            "title": "OneAtlas",
            "workspaceId": "1898ea7e-d3ac-4f74-b374-0f1496388b00",
            "offers": []
        },
        {
            "_links": {
                "self": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13"
                },
                "contract": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/ff731b8d-5637-40aa-89ad-daa736613714"
                },
                "reports": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/0b9da7d1-5b21-4532-84db-fd8b399ec47e/reports"
                },
                "deliveries": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/deliveries?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },    
                "payments": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/8fe89b39-9745-40b1-9a1f-5ce98aba2b13/payments"
                },
                "orders": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/orders?subscriptionId=0b9da7d1-5b21-4532-84db-fd8b399ec47e"
                },
                "packs": {
                    "href": "https://data.api.oneatlas.airbus.com/api/v1/subscriptions/0b9da7d1-5b21-4532-84db-fd8b399ec47e/packs"
                }
            },
            "id": "8fe8db39-9745-40b1-9a1f-5cf98ab2b13",
            "status": "active",
            "startedAt": "2019-01-03T08:13:54.780700+00:00",
            "endedAt": "2019-07-03T08:13:54.780700+00:00",
            "service": "data",
            "isAmountEstimated": "false",
            "title": "custom",
            "kind": "subscription.data.premium",
            "offers": [
                "order.data.gb.product"
            ],
            "type": "view",
            "duration": 6,
            "tileAmount": 150000,
            "paymentModality": "monthly",
            "monthlyPrice": 0,
            "streamingPlan": "advanced",
            "consumptionMode": "gb",
            "amountConsumed": 60564344,
            "amountMax": 101293740
        },
      }

Search & Order

You should now know the exact details of your streaming plan. You should now have everything you need to take full advantage of our APIs. This next section will walk you through searching our Living Library catalogue and ordering an image of your choice.

Search for images

Searching our Living Library is simple. All you need to do is call the /opensearch endpoint and provide parameters in compliance with OpenSearch standard. These parameters can include a bounding box, GeoJSON polygon, dates and more.


For more information about these filters, take a look at some examples in the Search Guide. In this tutorial example we are going to filter the search using a GeoJSON polygon. Our example is searching for images within the scenic town of Cavtat in Croatia. Feel free to use a different GeoJSON polygon if you wish.

curl -X POST 'https://search.foundation.api.oneatlas.airbus.com/api/v2/opensearch' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json'
  -d '{
  "itemsPerPage": 12,
  "startPage": 1,
  "cloudCover": "[0,100]",
  "incidenceAngle": "[0,90]",
  "sortBy": "-acquisitionDate",
  "workspace": "public",
  "processingLevel": "SENSOR",
  "relation": "intersects",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
        [
            [
                18.19021469803709,
                42.65838625971582
            ],
            [
                18.44677413880892,
                42.65077884078982
            ],
            [
                18.44409024457931,
                42.4205262624631
            ],
            [
                18.19013378078468,
                42.42607365097246
            ],
            [
                18.19021469803709,
                42.65838625971582
            ]
        ]
    ]
  }
}'

var data = JSON.stringify({
  "geometry": {
    "coordinates": [
      [
        [
          18.19021469803709,
          42.65838625971582
        ],
        [
          18.44677413880892,
          42.65077884078982
        ],
        [
          18.44409024457931,
          42.4205262624631
        ],
        [
          18.19013378078468,
          42.42607365097246
        ],
        [
          18.19021469803709,
          42.65838625971582
        ]
      ]
    ],
    "type": "Polygon"
  }
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://search.foundation.api.oneatlas.airbus.com/search/api/v2/opensearch");
xhr.setRequestHeader("Authorization", "Bearer <your_access_token>");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

headers = {
    'Authorization': 'Bearer <access_token>'
    'Content-Type': 'application/json',
}

data = '{"geometry": {"coordinates": 18.19021469803709,42.65838625971582,18.44677413880892,42.65077884078982,18.44409024457931,42.4205262624631,18.19013378078468,42.42607365097246,18.19021469803709,42.65838625971582,"type": "Polygon"}}'

response = requests.post('https://search.foundation.api.oneatlas.airbus.com/api/v2/opensearch', verify=False, headers=headers, data=data)

print(response.text)

Note: When searching, you will receive results from the full catalog as well as the Living Library. If you want to search only Living Library results, you will need to filter using processingLevel. This value could be equal to SENSOR (images which meet Living Library criteria) and ALBUM (images that do not meeting Living Library criteria in terms of incidence angle and cloud cover. They can not be streamed on-the-fly but you will be able to order them soon, for delivery in your private workspace). Below is an example of a call:

curl -X GET \
  'https://search.foundation.api.oneatlas.airbus.com/api/v1/opensearch?processingLevel=SENSOR' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \

You should return several images in the matter of seconds relating to your chosen parameters. The example below shows just a snippet of the results:

{
    "error": false,
    "features": [
        {
            "_links": {
                "delete": {
                    "href": "https://workspaces.oneatlas.private.geoapi-airbusds.com/api/v1/workspaces/0e33eb50-3404-48ad-b835-b0b4b72a5625/types/satellite_imagery/items/e459d653-468f-471b-8d6e-90b13b14c655",
                    "name": "Delete",
                    "type": "HTTP"
                },
                "metadata": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/e459d653-468f-471b-8d6e-90b13b14c655/metadata",
                    "name": "Metadata",
                    "type": "HTTP"
                },
                "quicklook": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/e459d653-468f-471b-8d6e-90b13b14c655/quicklook",
                    "name": "QuickLook",
                    "type": "HTTP"
                },
                "thumbnail": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/e459d653-468f-471b-8d6e-90b13b14c655/thumbnail",
                    "name": "Thumbnail",
                    "type": "HTTP"
                },
                "wms": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/e459d653-468f-471b-8d6e-90b13b14c655/wms",
                    "name": "WMS",
                    "type": "WMS"
                },
                "wmts": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/e459d653-468f-471b-8d6e-90b13b14c655/wmts",
                    "name": "WMTS",
                    "type": "WMTS"
                }
            },
            "geometry": {
                "coordinates": [
                    [
                        [
                            -79.6004740473,
                            62.5991162052
                        ],
                        [
                            -78.3906212349,
                            62.5893798561
                        ],
                        [
                            -78.3941369259,
                            62.0569309149
                        ],
                        [
                            -79.5956204515,
                            62.0695559704
                        ],
                        [
                            -79.6004740473,
                            62.5991162052
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "properties": {
                "acquisitionDate": "2018-08-27T16:29:21.124Z",
                "acquisitionStation": "SV1",
                "archivingCenter": "FR1",
                "azimuthAngle": 307.695448902,
                "cloudCover": 61.4,
                "commercialReference": "SO18022823",
                "constellation": "SPOT",
                "correlationId": "f334ee62-74db-4cbc-85ef-47f9b930741e",
                "expirationDate": "2019-08-30T07:06:16.522195753Z",
                "format": "image/jp2",
                "id": "e459d653-468f-471b-8d6e-90b13b14c655",
                "illuminationAzimuthAngle": 164.8027404,
                "illuminationElevationAngle": 37.7839600556,
                "incidenceAngle": 11.2809233557,
                "incidenceAngleAcrossTrack": -9.27954139844,
                "incidenceAngleAlongTrack": -6.51409289749,
                "organisationName": "AIRBUS DS",
                "parentIdentifier": "DS_SPOT6_201808271629211_FR1_FR1_SV1_SV1_W079N62_01871",
                "platform": "SPOT6",
                "processingCenter": "AOC",
                "processingDate": "2018-08-29T19:58:17Z",
                "processingLevel": "SENSOR",
                "processorName": "IMFv6",
                "productCategory": "image",
                "productType": "bundle",
                "productionStatus": "IN_CLOUD",
                "publicationDate": "2018-08-30T07:06:16.522195753Z",
                "qualified": false,
                "resolution": 1.57121,
                "sensorType": "OPTICAL",
                "snowCover": 0,
                "sourceIdentifier": "SEN_SPOT6_20180827_162921300_000",
                "spectralRange": "VISIBLE",
                "title": "SEN_SPOT6_20180827_162921300_000",
                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625",
                "workspaceName": "public",
                "workspaceTitle": "Public"
            },
            "rights": {
                "browse": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.581647813Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "8d21eca0-ad73-4d9d-8f04-29c8cd83e2c4",
                            "rights": {
                                "browse": {}
                            },
                            "subscriptionId": "f375c5ce-daba-412a-ace3-9092539cd1a8",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                },
                "wms": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.390365151Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "a4746d2a-7ef2-48c1-9c98-ccbe939a242b",
                            "rights": {
                                "wms": {},
                                "wmts": {}
                            },
                            "subscriptionId": "6f06e275-5327-4752-86b1-93867c27e56f",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                },
                "wmts": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.390365151Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "a4746d2a-7ef2-48c1-9c98-ccbe939a242b",
                            "rights": {
                                "wms": {},
                                "wmts": {}
                            },
                            "subscriptionId": "6f06e275-5327-4752-86b1-93867c27e56f",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                }
            },
            "type": "Feature"
        },
        {
            "_links": {
                "delete": {
                    "href": "https://workspaces.oneatlas.private.geoapi-airbusds.com/api/v1/workspaces/0e33eb50-3404-48ad-b835-b0b4b72a5625/types/satellite_imagery/items/df89db9b-e35a-46ee-aad5-f3e1f18bf0ae",
                    "name": "Delete",
                    "type": "HTTP"
                },
                "metadata": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/df89db9b-e35a-46ee-aad5-f3e1f18bf0ae/metadata",
                    "name": "Metadata",
                    "type": "HTTP"
                },
                "quicklook": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/df89db9b-e35a-46ee-aad5-f3e1f18bf0ae/quicklook",
                    "name": "QuickLook",
                    "type": "HTTP"
                },
                "thumbnail": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/df89db9b-e35a-46ee-aad5-f3e1f18bf0ae/thumbnail",
                    "name": "Thumbnail",
                    "type": "HTTP"
                },
                "wms": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/df89db9b-e35a-46ee-aad5-f3e1f18bf0ae/wms",
                    "name": "WMS",
                    "type": "WMS"
                },
                "wmts": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/df89db9b-e35a-46ee-aad5-f3e1f18bf0ae/wmts",
                    "name": "WMTS",
                    "type": "WMTS"
                }
            },
            "geometry": {
                "coordinates": [
                    [
                        [
                            100.331087773,
                            57.286615318
                        ],
                        [
                            101.335582984,
                            57.2848905567
                        ],
                        [
                            101.330053452,
                            56.7493429839
                        ],
                        [
                            100.337803774,
                            56.7519940149
                        ],
                        [
                            100.331087773,
                            57.286615318
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "properties": {
                "acquisitionDate": "2018-08-27T04:11:02.249Z",
                "acquisitionStation": "FR1",
                "archivingCenter": "FR1",
                "azimuthAngle": 336.541526209,
                "cloudCover": 0,
                "commercialReference": "SO18022823",
                "constellation": "SPOT",
                "correlationId": "94dd9b58-931d-4905-8566-3ccfe8bb8512",
                "expirationDate": "2019-08-30T07:04:29.282437526Z",
                "format": "image/jp2",
                "id": "df89db9b-e35a-46ee-aad5-f3e1f18bf0ae",
                "illuminationAzimuthAngle": 157.365191931,
                "illuminationElevationAngle": 42.0314192766,
                "incidenceAngle": 4.4795584183,
                "incidenceAngleAcrossTrack": -2.16042728059,
                "incidenceAngleAlongTrack": -3.06803280713,
                "organisationName": "AIRBUS DS",
                "parentIdentifier": "DS_SPOT7_201808270411022_FR1_FR1_FR1_FR1_E101N57_01871",
                "platform": "SPOT7",
                "processingCenter": "AOC",
                "processingDate": "2018-08-29T20:00:58Z",
                "processingLevel": "SENSOR",
                "processorName": "IMFv6",
                "productCategory": "image",
                "productType": "bundle",
                "productionStatus": "IN_CLOUD",
                "publicationDate": "2018-08-30T07:04:29.282437526Z",
                "qualified": false,
                "resolution": 1.53265,
                "sensorType": "OPTICAL",
                "snowCover": 0,
                "sourceIdentifier": "SEN_SPOT7_20180827_041102400_000",
                "spectralRange": "VISIBLE",
                "title": "SEN_SPOT7_20180827_041102400_000",
                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625",
                "workspaceName": "public",
                "workspaceTitle": "Public"
            },
            "rights": {
                "browse": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.581647813Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "8d21eca0-ad73-4d9d-8f04-29c8cd83e2c4",
                            "rights": {
                                "browse": {}
                            },
                            "subscriptionId": "f375c5ce-daba-412a-ace3-9092539cd1a8",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                },
                "wms": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.390365151Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "a4746d2a-7ef2-48c1-9c98-ccbe939a242b",
                            "rights": {
                                "wms": {},
                                "wmts": {}
                            },
                            "subscriptionId": "6f06e275-5327-4752-86b1-93867c27e56f",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                },
                "wmts": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.390365151Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "a4746d2a-7ef2-48c1-9c98-ccbe939a242b",
                            "rights": {
                                "wms": {},
                                "wmts": {}
                            },
                            "subscriptionId": "6f06e275-5327-4752-86b1-93867c27e56f",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                }
            },
            "type": "Feature"
        },
        {
            "_links": {
                "delete": {
                    "href": "https://workspaces.oneatlas.private.geoapi-airbusds.com/api/v1/workspaces/0e33eb50-3404-48ad-b835-b0b4b72a5625/types/satellite_imagery/items/1f5a3bda-8e35-4704-82ca-27dbfae58fc4",
                    "name": "Delete",
                    "type": "HTTP"
                },
                "metadata": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/1f5a3bda-8e35-4704-82ca-27dbfae58fc4/metadata",
                    "name": "Metadata",
                    "type": "HTTP"
                },
                "quicklook": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/1f5a3bda-8e35-4704-82ca-27dbfae58fc4/quicklook",
                    "name": "QuickLook",
                    "type": "HTTP"
                },
                "thumbnail": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/1f5a3bda-8e35-4704-82ca-27dbfae58fc4/thumbnail",
                    "name": "Thumbnail",
                    "type": "HTTP"
                },
                "wms": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/1f5a3bda-8e35-4704-82ca-27dbfae58fc4/wms",
                    "name": "WMS",
                    "type": "WMS"
                },
                "wmts": {
                    "href": "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/1f5a3bda-8e35-4704-82ca-27dbfae58fc4/wmts",
                    "name": "WMTS",
                    "type": "WMTS"
                }
            },
            "geometry": {
                "coordinates": [
                    [
                        [
                            -97.5655486139,
                            43.7419084893
                        ],
                        [
                            -96.7962782903,
                            43.7527037444
                        ],
                        [
                            -96.8008304963,
                            43.2195591894
                        ],
                        [
                            -97.560216004,
                            43.2103713303
                        ],
                        [
                            -97.5655486139,
                            43.7419084893
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "properties": {
                "acquisitionDate": "2018-08-24T16:58:22.749Z",
                "acquisitionStation": "SV1",
                "archivingCenter": "FR1",
                "azimuthAngle": 33.6952998936,
                "cloudCover": 2.54,
                "commercialReference": "SO18022823",
                "constellation": "SPOT",
                "correlationId": "8cdf8476-ba97-4b1c-a5e2-bc51e7f96b41",
                "expirationDate": "2019-08-30T07:02:42.28029458Z",
                "format": "image/jp2",
                "id": "1f5a3bda-8e35-4704-82ca-27dbfae58fc4",
                "illuminationAzimuthAngle": 140.454551832,
                "illuminationElevationAngle": 52.5634223274,
                "incidenceAngle": 11.8848831728,
                "incidenceAngleAcrossTrack": 7.02760267831,
                "incidenceAngleAlongTrack": -9.50177545448,
                "organisationName": "AIRBUS DS",
                "parentIdentifier": "DS_SPOT7_201808241658227_FR1_FR1_SV1_SV1_W097N43_01871",
                "platform": "SPOT7",
                "processingCenter": "AOC",
                "processingDate": "2018-08-29T19:50:23Z",
                "processingLevel": "SENSOR",
                "processorName": "IMFv6",
                "productCategory": "image",
                "productType": "bundle",
                "productionStatus": "IN_CLOUD",
                "publicationDate": "2018-08-30T07:02:42.28029458Z",
                "qualified": false,
                "resolution": 1.56425,
                "sensorType": "OPTICAL",
                "snowCover": 0,
                "sourceIdentifier": "SEN_SPOT7_20180824_165822900_000",
                "spectralRange": "VISIBLE",
                "title": "SEN_SPOT7_20180824_165822900_000",
                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625",
                "workspaceName": "public",
                "workspaceTitle": "Public"
            },
            "rights": {
                "browse": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.581647813Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "8d21eca0-ad73-4d9d-8f04-29c8cd83e2c4",
                            "rights": {
                                "browse": {}
                            },
                            "subscriptionId": "f375c5ce-daba-412a-ace3-9092539cd1a8",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                },
                "wms": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.390365151Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "a4746d2a-7ef2-48c1-9c98-ccbe939a242b",
                            "rights": {
                                "wms": {},
                                "wmts": {}
                            },
                            "subscriptionId": "6f06e275-5327-4752-86b1-93867c27e56f",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                },
                "wmts": {
                    "privileges": [
                        {
                            "createdAt": "2018-08-29T15:14:29.390365151Z",
                            "filter": {
                                "workspaceId": "0e33eb50-3404-48ad-b835-b0b4b72a5625"
                            },
                            "id": "a4746d2a-7ef2-48c1-9c98-ccbe939a242b",
                            "rights": {
                                "wms": {},
                                "wmts": {}
                            },
                            "subscriptionId": "6f06e275-5327-4752-86b1-93867c27e56f",
                            "userId": "5aea35c3-ca12-4c55-b455-2df467b87de1"
                        }
                    ]
                }
            },
            "type": "Feature"

results continued...

View QuickLook

The Search API returns a list of links including QuickLook. This link provides an overview of the area of ​​interest relating to the coordinates which were given in parameter to the API. This way you can preview the image before you buy. For further details about imagery services, please go to the Image access guide.

Please note: QuickLook images will not be displayed at the same resolution as when purchased.


Let’s give a QuickLook a go. Remember to replace <id> with the id of your image:

curl -X GET \
 https://access.foundation.api.oneatlas.airbus.com/api/v1/items/<id>/quicklook \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  > picture.jpg

Not available.

headers = {
    'Authorization': 'Bearer <access_token>',
    'Cache-Control': 'no-cache',
}

response = requests.get('https://access.foundation.api.oneatlas.airbus.com/api/v1/items/<id>/quicklook', verify=False, headers=headers)

open('quick_look.png', 'wb').write(response.content)

QuickLook

You can also specify a width on your QuickLook images:

curl -X GET \
 https://access.foundation.api.oneatlas.airbus.com/api/v1/items/<id>/quicklook?width=250 \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  > picture.jpg

QuickLook

Access images in streaming

Our search APIs allow you to receive mapping tiles in both WMS and WMTS streaming formats. The example below shows a WMTS request. Simply replace <id> with the id of your image to request the metadata:

curl -X GET https://access.foundation.api.oneatlas.airbus.com/api/v1/items/<id>/wmts \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json'

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://access.foundation.api.oneatlas.airbus.com/api/v1/items/<id>/wmts");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

headers = {
    'Authorization': 'Bearer <access_token>   -H Cache-Control:',
}

response = requests.get('https://access.foundation.api.oneatlas.airbus.com/api/v1/items/<id>/wmts', headers=headers)

print (response.text)

This will return the GetCapabilities XML file for the image you wish to stream. You can see an example of this below:

<Capabilities xmlns="http://www.opengis.net/wmts/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:gml="http://www.opengis.net/gml" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ows="http://www.opengis.net/ows/1.1" version="1.0.0" xsi:schemaLocation="http://www.opengis.net/wmts/1.0 http://schemas.opengis.net/wmts/1.0/wmtsGetCapabilities_response.xsd">
        <Layer xmlns:ows="http://www.opengis.net/ows/1.1">
            <ows:Title>IDP On The Fly Ortho Imagery (Geographic)</ows:Title>
            <ows:Abstract>IDP On The Fly Ortho Imagery from DaaS</ows:Abstract>
            <ows:Identifier>default</ows:Identifier>
            <ows:BoundingBox crs="urn:ogc:def:crs:OGC:1.3:CRS84">
                <ows:LowerCorner>29.30212505097054 52.5414838102001</ows:LowerCorner>
                <ows:UpperCorner>29.37644730946102 52.80838841780883</ows:UpperCorner>
            </ows:BoundingBox>
            <ows:WGS84BoundingBox crs="urn:ogc:def:crs:OGC:2:84">
                <ows:LowerCorner>52.5414838102001 29.30212505097054</ows:LowerCorner>
                <ows:UpperCorner>52.80838841780883 29.37644730946102</ows:UpperCorner>
            </ows:WGS84BoundingBox>
            <Style isDefault="true">
                <ows:Title>Default Style</ows:Title>
                <ows:Identifier>rgb</ows:Identifier>
            </Style>
            <Format>image/png</Format>
            <TileMatrixSetLink>
                <TileMatrixSet>4326</TileMatrixSet>
            </TileMatrixSetLink>
            <ResourceURL format="image/png" resourceType="tile" template="https://access.foundation.api.oneatlas.airbus.com/api/v1/items/d2c6220a-2475-427b-81b0-6e418bdd7990/wmts/tiles/1.0.0/default/{Style}/{TileMatrixSet}/{TileMatrix}/{TileCol}/{TileRow}.png"/>
        </Layer>
        <TileMatrixSet xmlns:ows="http://www.opengis.net/ows/1.1">
            <ows:Title>WorldCRS84Quad (EPSG:4326)</ows:Title>
            <ows:Identifier>4326</ows:Identifier>
            <ows:BoundingBox crs="urn:ogc:def:crs:EPSG:6.3:4326">
                <ows:LowerCorner>-180.000000 -90.000000</ows:LowerCorner>
                <ows:UpperCorner>180.000000 90.000000</ows:UpperCorner>
            </ows:BoundingBox>
            <ows:SupportedCRS>urn:ogc:def:crs:EPSG:6.3:4326</ows:SupportedCRS>
            <WellKnownScaleSet>urn:ogc:def:wkss:OGC:1.0:GoogleCRS84Quad</WellKnownScaleSet>
            <TileMatrix>
                <ows:Identifier>10</ows:Identifier>
                <ScaleDenominator>272989.3867327723</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>2048</MatrixWidth>
                <MatrixHeight>1024</MatrixHeight>
            </TileMatrix>
            <TileMatrix>
                <ows:Identifier>11</ows:Identifier>
                <ScaleDenominator>136494.6933663862</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>4096</MatrixWidth>
                <MatrixHeight>2048</MatrixHeight>
            </TileMatrix>
            <TileMatrix>
                <ows:Identifier>12</ows:Identifier>
                <ScaleDenominator>68247.34668319309</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>8192</MatrixWidth>
                <MatrixHeight>4096</MatrixHeight>
            </TileMatrix>
            <TileMatrix>
                <ows:Identifier>13</ows:Identifier>
                <ScaleDenominator>34123.67334159654</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>16384</MatrixWidth>
                <MatrixHeight>8192</MatrixHeight>
            </TileMatrix>
            <TileMatrix>
                <ows:Identifier>14</ows:Identifier>
                <ScaleDenominator>17061.83667079827</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>32768</MatrixWidth>
                <MatrixHeight>16384</MatrixHeight>
            </TileMatrix>
            <TileMatrix>
                <ows:Identifier>15</ows:Identifier>
                <ScaleDenominator>8530.918335399136</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>65536</MatrixWidth>
                <MatrixHeight>32768</MatrixHeight>
            </TileMatrix>
            <TileMatrix>
                <ows:Identifier>16</ows:Identifier>
                <ScaleDenominator>4265.459167699568</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>131072</MatrixWidth>
                <MatrixHeight>65536</MatrixHeight>
            </TileMatrix>
            <TileMatrix>
                <ows:Identifier>17</ows:Identifier>
                <ScaleDenominator>2132.729583849784</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>262144</MatrixWidth>
                <MatrixHeight>131072</MatrixHeight>
            </TileMatrix>
            <TileMatrix>
                <ows:Identifier>18</ows:Identifier>
                <ScaleDenominator>1066.364791924892</ScaleDenominator>
                <TopLeftCorner>90.000000 -180.000000</TopLeftCorner>
                <TileWidth>256</TileWidth>
                <TileHeight>256</TileHeight>
                <MatrixWidth>524288</MatrixWidth>
                <MatrixHeight>262144</MatrixHeight>
            </TileMatrix>
        </TileMatrixSet>
    </Contents>
    <ServiceMetadataURL xlink:href="https://access.foundation.api.oneatlas.airbus.com/api/v1/items/d2c6220a-2475-427b-81b0-6e418bdd7990/wmts/1.0.0/WMTSCapabilities.xml"/>
</Capabilities>

To learn more about streaming your imagery using GIS tools, visit our View Service guide.

Check your balance

You should now have found images you would like to purchase, but first lets check that you have sufficient balance. To get information about your balance you can use the endpoint/api/v1/me:

curl -X GET \
  https://data.api.oneatlas.airbus.com/api/v1/me \
  -H 'Authorization: Bearer <access_token>'

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/me");
xhr.setRequestHeader("Authorization", "Bearer <your_access_token>");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

headers = {
    'Authorization': 'Bearer <access token>'
}

response = requests.get('https://data.api.oneatlas.airbus.com/api/v1/me', headers=headers)

print (response.text);

Take a look at the balance tag value. Make note of this for the next step:

{
    "_links": {
        "self": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/me"
        }
    },
    "id": "bf3d937a-e846-446a-e5b6-0a26227b892f",
    "status": "created",
    "createdAt": "2018-04-30T08:51:43.393720+00:00",
    "roles": [
        "user"
    ],
    "contract": {
        "_links": {
            "self": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083"
            },
            "orders": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/orders"
            },
            "payments": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/payments"
            },
            "subscriptions": {
                "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/8b273bd7-5626-4ef3-80cf-c4fc33191083/subscriptions"
            }
        },
        "id": "8b273bd7-5626-4ef3-80cf-c4fc33191083",
        "kind": "contract.view",
        "name": "airbus tutorials test",
        "balance": 3741,
        "status": "created",
        "createdAt": "2018-06-11T09:23:01.868510+00:00",
        "workspaceId": "148eebbd-a9b9-4cf6-97d3-87237901a7b9",
        "offers": [
            "order.product",
            "order.subscription.change-detection",
            "order.subscription.streaming"
        ]
    }
}

Calculate the price of the image

In order to get the price of the product, retrieve the id from the previous search request and the coordinates of the geometry. You will need to replace the id and coordinates with the image you are interested in.

Note: The processingLevel must equal to “SENSOR” for the image.

Enter this data into the endpoint /api/v1/prices like the following example:

curl -X POST \
  https://data.api.oneatlas.airbus.com/api/v1/prices \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{ "kind": "order.product",
  "products": [
    {
      "productType": "bundle",
      "radiometricProcessing": "REFLECTANCE",
      "imageFormat": "image/jp2",
      "crsCode": "urn:ogc:def:crs:EPSG::4326",
      "id": "ce4a073e-915a-4e15-b943-4470e02e0511",
      "aoi": {
        "type": "Polygon",
        "coordinates": [
          [
              [
                    1.240702761700962,
                    43.71466198202646
                  ],
                  [
                    1.567967301703224,
                    43.70248156062971
                  ],
                  [
                    1.568833709452247,
                    43.470228154858
                  ],
                  [
                    1.239288081223572,
                    43.48647760616458
                  ],
                  [
                    1.240702761700962,
                    43.71466198202646
                  ]

          ]
        ]
      }
    }
  ]

  }'

var data = JSON.stringify({
  "kind": "productOrder",
  "products": [
    {
      "productType" : "bundle",
      "radiometricProcesing": "DISPLAY",
      "imageFormat": "image/jp2",
      "id": "22f1998c-ebd9-49a4-b4f6-d363177c1388",
      "aoi": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1.240702761700962,
              43.71466198202646
            ],
            [
              1.567967301703224,
              43.70248156062971
            ],
            [
              1.568833709452247,
              43.470228154858
            ],
            [
              1.239288081223572,
              43.48647760616458
            ],
            [
              1.240702761700962,
              43.71466198202646
            ]
          ]
        ]
      }
    }
  ]
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://data.api.oneatlas.airbus.com}//api/v1/prices");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

headers = {
    'Authorization': 'Bearer <access_token>',
    'Content-Type': 'application/json',
}

data = '{"kind": "order.product", "products": [{ "productType" : "bundle", "radiometricProcessing": "REFLECTANCE", "imageFormat": "image/jp2", "crsCode": "urn:ogc:def:crs:EPSG::4326", "id": "69702521-eaf2-4bdb-a792-7cba637e5c96", "aoi": { "type": "Polygon", "coordinates": [[ [137.7410888671875, -32.52076297625622], [137.80563354492188, -32.52076297625622], [137.80563354492188, -32.460529179506416], [137.7410888671875, -32.460529179506416], [137.7410888671875, -32.52076297625622]]]}}]}   '

response = requests.post('https://data.api.oneatlas.airbus.com/api/v1/prices', verify=False, headers=headers, data=data)

print (response.text)

As a result you’ll get the price next to the tag credits:

{
    "payload": {
        "kind": "order.product",
        "products": [
            {
                "productType": "bundle",
                "radiometricProcessing": "REFLECTANCE",
                "imageFormat": "image/jp2",
                "crsCode": "urn:ogc:def:crs:EPSG::4326",
                "id": "xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww",
                "aoi": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                          [
                            1.240702761700962,
                            43.71466198202646
                          ],
                          [
                            1.567967301703224,
                            43.70248156062971
                          ],
                          [
                            1.568833709452247,
                            43.470228154858
                          ],
                          [
                            1.239288081223572,
                            43.48647760616458
                          ],
                          [
                            1.240702761700962,
                            43.71466198202646
                          ]
                        ]
                    ]
                }
            }
        ]
    },
    "deliveries": [
        {
            "datas": {
                "aoi": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                          [
                            1.240702761700962,
                            43.71466198202646
                          ],
                          [
                            1.567967301703224,
                            43.70248156062971
                          ],
                          [
                            1.568833709452247,
                            43.470228154858
                          ],
                          [
                            1.239288081223572,
                            43.48647760616458
                          ],
                          [
                            1.240702761700962,
                            43.71466198202646
                          ]
                        ]
                    ]
                },
                "productType": "bundle",
                "radiometricProcessing": "REFLECTANCE",
                "imageFormat": "image/jp2",
                "crsCode": "urn:ogc:def:crs:EPSG::4326",
                "id": "xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww",
                "sourceId": "DS_PHR1B_201801080119199_FR1_PX_E133S26_0203_00541"
            },
            "id": "db234757-415e-45ea-91fe-b4a3430d9262",
            "price": 377,
            "areaKm2": 37.75
        }
    ],
    "price": {
        "credits": 377,
        "areaKm2": 37.75
    },
    "feasibility": "automatic",
    "orderable": "ok"
}

Order your product

We’ve successfully managed to search for an image and retrieve the price. All we have left to do is order! Simply create an order using the details of the product returned previously:

curl -X POST \
  https://data.api.oneatlas.airbus.com/api/v1/api/v1/orders \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "order.product",
  "products": [
    {
      "productType": "bundle",
      "radiometricProcessing": "REFLECTANCE",
      "imageFormat": "image/jp2",
      "crsCode": "urn:ogc:def:crs:EPSG::4326",
      "id": "xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww",
      "aoi": {
        "type": "Polygon",
        "coordinates": [
                [
                  [
                    1.240702761700962,
                    43.71466198202646
                  ],
                  [
                    1.567967301703224,
                    43.70248156062971
                  ],
                  [
                    1.568833709452247,
                    43.470228154858
                  ],
                  [
                    1.239288081223572,
                    43.48647760616458
                  ],
                  [
                    1.240702761700962,
                    43.71466198202646
                  ]
                ]
        ]
      }
    }
  ]
}'

var data = JSON.stringify({
  "kind": "order.product",
  "products": [
    {
      "productType": "bundle",
      "radiometricProcessing": "REFLECTANCE",
      "imageFormat": "image/jp2",
      "crsCode": "urn:ogc:def:crs:EPSG::4326",
      "id": "xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww",
      "aoi": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1.240702761700962,
              43.71466198202646
            ],
            [
              1.567967301703224,
              43.70248156062971
            ],
            [
              1.568833709452247,
              43.470228154858
            ],
            [
              1.239288081223572,
              43.48647760616458
            ],
            [
              1.240702761700962,
              43.71466198202646
            ]
          ]
        ]
      }
    }
  ]
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://data.api.oneatlas.airbus.com/api/v1/orders");
xhr.setRequestHeader("Authorization", "Bearer <access_token");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

Not yet available

Note: Your kind must be order.data.gb.productif you have a GB subscription or order.product if you have a tiles subscription.

This should return a status ordered:

{
    "_links": {
        "self": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww"
        },
        "contract": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/contracts/xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww"
        },
        "payments": {
            "href": "https://data.api.oneatlas.airbus.com/api/v1/orders/5xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww/payments"
        }
    },
    "id": "xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww",
    "kind": "order.product",
    "createdAt": "2018-12-03T16:26:12.119065+00:00",
    "createdBy": "75e0cc0b-bece-47bb-fa1c-0644d3fe3cf6",
    "status": "ordered",
    "contractId": "5349b24f-eed4-44f6-a98b-d9ddd88e4cab",
    "price": 377,
    "payload": {
        "kind": "order.product",
        "products": [
            {
                "productType": "bundle",
                "radiometricProcessing": "REFLECTANCE",
                "imageFormat": "image/jp2",
                "crsCode": "urn:ogc:def:crs:EPSG::4326",
                "id": "xxxxxx-yyyyyy-zzzzzz-vvvvvv-wwwwww",
                "aoi": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                          [
                            1.240702761700962,
                            43.71466198202646
                          ],
                          [
                            1.567967301703224,
                            43.70248156062971
                          ],
                          [
                            1.568833709452247,
                            43.470228154858
                          ],
                          [
                            1.239288081223572,
                            43.48647760616458
                          ],
                          [
                            1.240702761700962,
                            43.71466198202646
                          ]
                        ]
                    ]
                }
            }
        ]
    }
}

Follow up your order

To check if your orders are status delivered, you can use the endpoint /api/v1/orders. Alternatively, if you know the orderId then you can add it to the endpoint like /api/v1/orders/{order_id}:

curl -X GET https://data.api.oneatlas.airbus.com/api/v1/orders/xxxxxxxx-yyyy-zzzz-wwww-vvvvvvvvvvvv \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json'

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://data.api.oneatlas.airbus.com/api/v1/orders/xxxxxxxx-yyyy-zzzz-vvvv-wwwwwwwwwwww");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer <access_token>");
xhr.setRequestHeader("Cache-Control", "no-cache");

xhr.send(data);

headers = {
    'Authorization': 'Bearer <access_token>',
    'Cache-Control': 'no-cache',
    'Content-Type': 'application/json',
}

response = requests.get('https://data.api.oneatlas.airbus.com/api/v1/orders/xxxxxxxx-yyyyy-zzzzz--vvvvv-wwwwwwww', headers=headers, verify=False)

print (response.text)

You will return the same result as you did in the order your product section of this tutorial.

Download an image

Our next step will show you how to download your purchased image. However you may have to wait a few minutes for the status of your order to change to delivered. Soon as your product is in a delivered state you will see a download url similar to the following:

https://data.api.oneatlas.airbus.com/api/v1/items/<image_id>/download

Note: Your id must be within your private workspace otherwise you will receive a “permission denied” error. You can retrieve images in your workspace by using the Search API and filtering by your workspaceId.

You can use the following get request to output the file as a zip:

curl -k GET \
  https://data.api.oneatlas.airbus.com/api/v1/items/90ebd420-fab4-49b7-85cd-ced051ea2343/download \
  -H 'Authorization: Bearer <access_token>' -o output_file.zip

Not available

Not available

© Airbus Defence and Space 2022. All rights reserved. Privacy Policy | Legal Information

Contact Us