Language

Detailed step-by-step explanations for Pay-Per-Order archive

Before ordering an archive product, you need to gather mandatory information that you will need later for the tasking itself. Steps 0.1 to 0.6 will lead you through this process.

Step 0.1: Get contracts

Request

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/contracts
REST verbGET
AuthenticationBearer token

Response

{
    "contracts": [
        {
            "contractId": "CisContractId",
            "customerId": "customerId",
            "name": "ContractName",
            "tradeAgreementUrl": "https://www.intelligence-airbusds.com/cgf/",
            "creditRemaining": "150.0",
            "currency": "EUR",
            "language": "en",
            "contractType": "ONEATLASDATA",
            "backendSource": "legacy"
        }
    ]
}

Export your CisContractId.

Note: “backendSource” can be either “legacy” or “neo”. SPOT and Pléiades can only be ordered through “legacy” type contract. Pléiades Neo can only be ordered through “neo” back-end.

Step 0.2: Get workspace

Note: method to retrieve workspace_id differs between SPOT / Pléiades and Pléiades Neo


Request

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/contracts
REST verbGET
AuthenticationBearer token

Response





Export your deliveryWorkspace.

Step 0.3: Get Product Types

This request displays the possible ordered productTypes associated to your contract.

Request

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/contracts/<CisContractId>/productTypes
REST verbGET
AuthenticationBearer token

Response




Choose one productTypeId among the possibilities.
The product type chosen indicates both the mission (SPOT or PLEIADES or PLEIADESNEO) and the tasking offer (ONEDAY, ONENOW, ONEPLAN).

Step 0.4: Get markets

Request

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/<cisContractId>/properties
REST verbGET
AuthenticationBearer access token

Response is a list of markets. Primary market is mandatory for ordering.




Step 0.5: Get available delivery types

You can see which delivery type are available thanks to the following request:

Request

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/contracts/<CisContractId>/deliveryTypes
REST verbGET
AuthenticationBearer access token

Response

{ 
    "deliveryTypes": [
        {
            "deliveryTypeId": "network",
            "label": "FTP + My Data"
        },
        {
            "deliveryTypeId": "MEDIA",
            "label": "MEDIA"
        }
    ]
}

All commercial imagery products will be made available in your private workspace (= ‘MyData’). For SPOT & Pléiades orders, we ensure - until further notice - double deliveries of products also on the Geodelivery (= ‘FTP’)

Step 0.6: Get Production Options

Request

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/contracts/<CisContractId>/productTypes/<productTypeId>/options
REST verbPOST
AuthenticationBearer token

Body request sample:




Response




Step 0.7: Get country label

Request

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/properties
REST verbGET
AuthenticationBearer token

Response is a list of countries and available labels. A label is mandatory to identify an user for ordering.




Step 1: Authenticate

Using you API Key, you will need to get an access token that enables authorization. Authorization refers to the process of determining what permissions an authenticated client has for a set of resources.
For security reasons this access token expires regularly then it’s necessary to renew the authentication process to get a new one.
Please refer to the dedicated Authentication Guide

Step 2: Browse archives

API Endpointhttps://search.foundation.api.oneatlas.airbus.com/api/v2/opensearch
REST verbPOST
AuthenticationBearer access token

Request




Our search API supports following criteria:

  • acquisitionDate

  • cloudCover

  • lastUpdateDate: this key is convenient if you want implement an automatic harvesting sequence

  • incidenceAngle

  • geometry in geojson

Our search API supports sorting items using cloudCover and dates (acquisitionDate and lastUpdateDate)



Each image is returned as a GeoJSON feature under the /features[] property.

  • id of the acquisition will be used for ordering

  • Cloud cover is calculated at acquisition level, not re-calculated at the Area of Interest

  • Most of the ‘links’ are not enabled / useful in case of an ALBUM, only quicklook and thumbnail can be used

Response




Step 3: Calculate Price

Note: This end-point will only work for AUTOMATIC request.

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/prices
REST verbPOST
AuthenticationBearer token



Step 4: Request a quotation

Note: This feature is only available for PleiadesNeo.

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/quotations
REST verbPOST
AuthenticationBearer token



Step 5: Create an order

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/orders
REST verbPOST
AuthenticationBearer token

catalogItemId to be used in the payload is to be retrieved from the result of Search under the key id




Response

{
    "quotationId": "QUO22054547",
    "currency": "EUR",
    "discountPercentage": 0.0,
    "discountValue": 0.0,
    "totalAmount": 0.0
}

Notes:

  • productTypeId can be retrieved using Get product types

  • Please refer to the dedicated Get production options for processing options

  • customerReference can be used throughout the ordering process to get the status of your order and find the images in your delivery workspace. It is as a consequence better to use 1 customerReference specific to each order

  • Dem and projection are not mandatory for primary, Dem is not mandatory for projected

  • The QUOid sent back in the response can be used to search for your order

  • The key fullStrip allows you to order the whole catalog image, when passed to true. In that case, the geometry portion of the aoi definition is not mandatory and can be deleted or will be ignored. This option is only available for PleiadesNeo



About multi-item and multi-aoi orders:

  • The number aoiId corresponds to both the id of the aoi

  • The number 1 in dem_1 and projection_1 refers to both the aoiId

Step 6: Get your imagery product

Once delivered, the acquisition will be placed in your private workspace. You can run this request to access these images:

API Endpointhttps://search.foundation.api.oneatlas.airbus.com/api/v2/opensearch
REST verbPOST
AuthenticationBearer access token

Request

{
    "itemsPerPage": 10,
    "startPage": 1,
    "workspace": "<workspace-Id>"
}

Our search API supports following criteria:

  • acquisitionDate

  • cloudCover

  • publicationDate: this key is convenient if you want implement an automatic harvesting sequence

  • incidenceAngle

  • geometry

  • customerReference: if you used a specific reference while ordering, this will allow you to easily identify your data

Each image is returned as a GeoJSON feature under the /features[] property. The download link is part of the returned links.

Response




Track your orders

Note: This feature is only available for PleiadesNeo.

You can see all your orders thanks to this request:

API Endpointhttps://order.api.oneatlas.airbus.com/api/v2/orders/search
REST verbPOST
AuthenticationBearer access token

Request




Some insight about the interesting keys to be used (not all keys are mandatory):

  • customerReference: is the reference you used when creating your order

  • quotationStatus: can be ACCEPTED (quotation has been accepted, order is running) or SENT(quotation not yet validated, order not yet running)

  • cis.quotation: id of the quotation can be used to search

  • contractId: id of the contract can be used to search

  • status: can be IN_PROGRESS (order is running) or DELIVERED (order finished, all data delivered) or CANCELLED (order cancelled)

  • technicalProduct.source.id: can be tasking or archive


Response



Manage quotations

Note: This feature is only available for PleiadesNeo.

You can get access quotations using the request:

API Endpointhttps://order.api.oneatlas.airbus.com/api/v2/orders/search
REST verbPOST
AuthenticationBearer access token

Request




Retrieve quotationId then

If you need to get a PDF version of the quotation:
API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/quotations/<quotationId>/export
REST verbGET
AuthenticationBearer access token



To accept a quotation:

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/contracts/<CisContractId>/quotations/<quotationId>/accept
REST verbPUT
AuthenticationBearer access token


Once accepted, the order is automatically created.

To refuse a quotation:

API Endpointhttps://order.api.oneatlas.airbus.com/api/v1/contracts/<CisContractId>/quotations/<quotationId>/refuse
REST verbPUT
AuthenticationBearer access token

Request

{"rejectionReasonId":1}

The rejectionReasonId matches the following rationals:

1: “The quote has expired”,

2": “I chose another imagery provider”,

3: “It doesn’t correspond to my budget expectations”,

4: “The tasking proposal is not answering my needs”,

5: “The licence doesn’t answer my operational needs”,

6: “I need to modify my request”,

7: “Other”

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

Contact Us