Language
OneAtlas Data
  1. Tasking
    1. Tasking introduction
      1. Overview of the requests
    2. API user guide
      1. Prerequisite
      2. OpenAPI documentation
      3. Get an API key
      4. Step 1: Authenticate
      5. Step 2: Get Contract Information
      6. Step 3: Get the Available Product Types
      7. Step 4: Get the Tasking Product Options
      8. Step 5: Check Feasibility
      9. Step 6: Get attempts
      10. Step 7: Calculate Price for a tasking
      11. Step 8: Order the tasking
      12. Step 9: Get your image once delivered
    3. More Options
      1. Available delivery type linked to your contract
      2. Get markets
      3. Track your tasking
      4. Get tasking segments
      5. Accept or refuse a segment
      6. Cancel a tasking
      7. Get Licence
    4. Glossary

Tasking

Tasking introduction

This guide will show step by step how to task our satellites online. One Tasking offer is designed around customers’ needs and is composed of four tasking options:

ONEDAY : Choose your acquisition day . Imagery acquisition for a specific day is now risk-free. 24 hours before your acquisition date, you receive a weather forecast by mail to let you confirm, postpone or cancel your request at no cost.

ONENOW : Access useful information in an instant. When immediate imagery is required, our satellites can be tasked to deliver valuable insights in the shortest possible timeframe. Don’t panic if it’s cloudy – we keep collecting images of your area until we are successful.

ONEPLAN : Obtain qualified coverage within an agreed timeframe. You select your timeframes, dates and preferred sensor – we ensure you receive the right qualified coverage, perfectly matching your project milestones.

ONESERIES : Get coverage on a regular basis. Whether you are dealing with long-term changes or highly dynamic situations, OneSeries brings you the required intelligence at the frequency you choose. For highest frequencies, our cloud cover commitment ensures you pay only for the most useful results.


Note: Image tasking requests always refer to dates in the future.

quicklook

Overview of the requests

This Sequence Order Diagram summarises the whole process of requesting a Tasking. Requests in grey return information on options. Therefore, their result can be hardcoded. Requests in black can not be avoided for a Tasking.

quicklook

API user guide

Prerequisite

You will need a OneAtlas account. Contact technicalsupport@intelligence-airbusds.com in case you need some support.

OpenAPI documentation

You can access the OpenAPI documentation through the endpoint below:

API Endpointhttps://order.api.oneatlas.airbus.com/openapi/public.yaml
REST verbGET
AuthenticationBearer token

Get an API key

Go to the OneAtlas Developer Portal and click on “Get your API key” menu. Enter your Login and password to connect; you will enter the page enabling you to manage your API keys. Click on “Create an API Key”. A new API Key pop-up:

quicklook

Save this API Key in a safe location as we won’t have a copy of it. If this API Key is lost, another API Key needs to be created again from scratch.

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. The endpoint to use to generate tokens is described in the following table:

API Endpointhttps://authenticate.foundation.api.oneatlas.airbus.com/auth/realms/IDP/protocol/openid-connect/token
REST verbPOST
AuthenticationAPI key

The required parameters are listed in the table below:

ParametersRequiredDescription
apikeyYesThe OneAtlas API key associated with the service account to authenticate.
client_idYesThe API service group accessed. This service group can be retrieved by consulting the service documentation or calling the unprotected /well_known/serviceGroup URI on the service itself.
grant_typeYesOneAtlas Grant type.Must be the value api_key for API key authentication.

Below is an example to retrieve an access token with the API Key:

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'
Not available

You will return an access token similar to this:

{
    "access_token": "ABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGH",
    "expires_in": 3600,
    "refresh_expires_in": 0,
    "token_type": "bearer",
    "not-before-policy": 0,
    "session_state": "0017679e-2c9c-4282-835b-45123688281a"
}

Step 2: Get Contract Information

The following commands are optional if you already know your workspaceId and CisContractId. You can run the following request to search for contract informations associated to the connected user:

API Endpointhttps://data.api.oneatlas.airbus.com/api/v1/me
REST verbGET
AuthenticationBearer token

Get workspace id response

{
    "_links": {},
    "id": "userId",
    "status": "created",
    "createdAt": "2021-02-09T16:29:55.750270+00:00",
    "roles": [
        "user"
    ],
    "contract": {
        "_links": {},
        "id": "contractId",
        "status": "created",
        "createdAt": "2021-02-05T17:44:42.228324+00:00",
        "offers": [
            "order.data.gb.product",
        ],
        "UCDB": "UCDB",
        "companyName": "companyName",
        "amountUnit": "EUR",
        "balanceUnit": "EUR",
        "kind": "contract.oneatlas.premium",
        "name": "PREMIUM.name",
        "balance": 15000,
        "workspaceId": "workspaceId"
    }
} 

Export your workspace_id

Get Cis contract id

The following command is used to retrieve details of a contract. It will enable you to get your CISContractName to run the tasking requests:

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

cisContracts 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.

Step 3: Get the Available 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

 {
    "productTypes": [
        {
            "productTypeId": "PleiadesTaskingOneDay",
            "technicalProduct": {
                "id": "PleiadesTaskingOneDay",
                "label": "Pleiades OneDay",
                "source": {
                    "id": "tasking",
                    "label": "One Tasking"
                },
                "sensor": {
                    "id": "pleiades",
                    "label": "Pléiades"
                },
                "target": {
                    "id": "oneday",
                    "label": "One Day"
                },
                "licences": null
            },
            "minimumOrderAreaApplied": 100,
            "descriptionUrl": "https://www.intelligence-airbusds.com/one-tasking/"
        },{
            "productTypeId": "SpotTaskingOneDay",
            "technicalProduct": {
                "id": "SpotTaskingOneDay",
                "label": "SPOT OneDay",
                "source": {
                    "id": "tasking",
                    "label": "One Tasking"
                },
                "sensor": {
                    "id": "spot",
                    "label": "SPOT"
                },
                "target": {
                    "id": "oneday",
                    "label": "One Day"
                },
                "licences": null
            },
            "minimumOrderAreaApplied": 500,
            "descriptionUrl": "https://www.intelligence-airbusds.com/one-tasking/"
}

Choose one productTypeId among the possibilities. This example will show a PleiadesTaskingOnePlan image: productTypeId =“PleiadesTaskingOnePlan”
The product type chosen indicates the mission (SPOT or PLEIADES). The product type also states it is a “tasking” order, and determines the programming type:
ONEDAY option allows our customers to choose their acquisition day. The highest satellite tasking priority is applied to the tasking request; we force the satellite to collect the area on the specific day required by the customer. The new collection will be delivered regardless of the cloud cover.
ONENOW option consists in intensive acquisitions of the customer’s area: it consists in up to 3 acquisitions resulting in 3 deliveries; all images are delivered regardless of the cloud cover; the tasking stops as soon as a good image is acquired. In case of poor weather conditions, if at the end of the 3 acquisitions, the area is still cloudy, upon customer’s decision, we continue collecting the area until the area is successfully collected.
ONEPLAN OnePan provides our customers with the right qualified coverage, perfectly matching their project milestones. You select your preferred sensor, survey period, as well as your acquisition parameters and on our side, we ensure the images are collected and delivered on time and within the requested specifications.
ONESERIES corresponds to a series of images acquired over the same area; Whether you are dealing with long-term changes or highly dynamic situations, OneSeries brings you the required intelligence at the frequency you choose.

Step 4: Get the Tasking Product Options

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

Body request sample:

 {
  "aoi": [
    {
      "polygonId": 1,
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1.4316558837890625,
              43.568824930165476
            ],
            [
              1.4316558837890625,
              43.601900054609445
            ],
            [
              1.4670181274414062,
              43.601900054609445
            ],
            [
              1.4670181274414062,
              43.568824930165476
            ],
            [
              1.4316558837890625,
              43.568824930165476
            ]
          ]]
      }
    }
  ]
}

You will receive the answer visible in the annexes. These options will enable you to select the radiometric processing, the pixel coding, the acquisition mode and other options.

Step 5: Check Feasibility

This step is not relevant for OneNow option. The following request returns the feasibility study result for tasking:

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

Body request sample:

 {
  "acquisitionDate": {
    "endDate": "2021-06-11T23:59:59.999Z",
    "startDate": "2021-05-12T11:03:19.052Z"
  },
  "contractId": "<CisContractId>",
  "missions": [
    "PLEIADES"
  ],
  "optical": {
    "acquisitionMode": "MONO",
    "maxCloudCover": 10,
    "maxIncidenceAngle": 50
  },
  "progTypeNames": [
    "ONEPLAN"
  ],
  "aoi": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          1.4316558837890625,
          43.568824930165476
        ],
        [
          1.4316558837890625,
          43.601900054609445
        ],
        [
          1.4670181274414062,
          43.601900054609445
        ], 
        [
          1.4670181274414062,
          43.568824930165476
        ],
        [
          1.4316558837890625,
          43.568824930165476
        ]
      ]
    ]
  }
}

Response

{
"progCapacities": [
        {
            "mission": "PLEIADES",
            "progTypes": [
                {
                    "name": "ONEPLAN",
                    "mission": "PLEIADES",
                    "feasibility": {
                        "classification": "CHALLENGING",
                        "automation": "AUTOMATIC",
                        "automationName": "AutomaticTasking30"
                    },
                    "available": true
                }
            ]
        }
    ]
}

classification, automation and automationName will be needed later.

If the automation is “MANUAL” a feasibility study will be needed. A feasibility study is a diagnosis performed by our tasking experts in order to organise the acquisition plan and estimate the confidence in covering the area of interest within the defined acquisition period and parameters. To study the feasibility of the tasking request, we ask the customer: where, by when and for which application the customer needs the new collection(s). With this information, the Tasking Team issues a tasking proposal that includes advice and recommendations that clearly indicate:


• The feasibility study diagnosis:feasible/difficult/very difficult
• The estimated area coverage:%
• New proposed parameters when relevant.


The feasibility study proposes the best programming parameters in order to successfully collect the area on time and on specifications (basis of our commitment and philosophy of One Tasking offer). However, the customer will always have the choice to select one tasking proposal or another.


OnePlan and OneSeries feasibility studies mainly focus on the desired timeframe compared to the location, the size, the angle and cloud constraints. Depending on all requested programming parameters, the Tasking Manager issues a diagnosis (feasible, difficult, and very difficult) to the customer and proposes alternatives if the feasibility results are ‘very difficult’ or ‘difficult’. − If the request is judged unachievable, the Tasking Manager sends two proposals: one for it to become ‘challenging’, one for it to become ‘achievable’ – each with the relevant quotations.


OneDay feasibility study mainly focuses on the accessibility of the entire area on the requested day, with an indication of the incidence angle. By default, extended incidence angle (maximum agility provided by the satellite) applies to OneDay taskings. However, the possibility is given to filter access for acquisitions with an incidence angle of 30° or less – providing the customer the opportunity to select a different date if the access on the given day for the reduced angle is not available. In case of areas larger than the maximum order size specified in One Tasking offer, the feasibility of OneDay tasking requests is studied by our tasking team who issues a diagnosis (feasible, difficult, and very difficult), and proposes alternatives to the customer if the tasking request is assessed as ‘difficult’ or “very difficult”.


OneNow feasibility studies mainly focus on the first 3 days when the area can be entirely collected after the desired start date, with an indication of the incidence angle. The possibility is given to filter access for acquisitions with an incidence angle of 30° or less – thus displaying the three new acquisitions days able to entirely cover the AOI with the reduced angle. No choice is given on the acquisitions days.


If the request is judged “difficult”, the Tasking Manager sends two feasibility studies: one with the requested parameters and the relevant quotation, and another one with different parameters, enabling to switch to “feasible”, with the relevant quotation.


In any case the customer will always have the choice between both tasking proposals.

Step 6: Get Attempts

Note: This step is only mandatory for ONEDAY and ONENOW. This request will offer you several choices:

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

Body request sample:

{
    "progTypeNames": [
        "ONEDAY"
    ],
    "missions": [
        "PLEIADES"
    ],
    "contractId": "<CisContractId>",
    "acquisitionDate": {
        "startDate": "2021-04-16T00:16:26.665Z",
        "endDate": null
    },
    "optical": {
        "acquisitionMode": "MONO",
        "maxCloudCover": 25,
        "maxIncidenceAngle": 30
    },
    "aoi": {
        "type": "Polygon",
        "coordinates": [
            [
                [1.3763809204101562, 43.545313140623726],
                [1.5095901489257812, 43.545313140623726],
                [1.5095901489257812,.656198305413156],
                [1.3763809204101562, 43.656198305413156],
                [1.3763809204101562, 43.545313140623726
]
            ]
        ]
    }
}

Response example

{
    "progCapacities": [
        {
            "mission": "PLEIADES",
            "progTypes": [
                {
                    "name": "ONEDAY",
                    "mission": "PLEIADES",
                    "segments": [
                        {
                            "id": "PHR1",
                            "footprint": {
                                "geometry": "POLYGON((1.298502 43.665978, 1.298175 43.535609, 1.589621 43.53495, 1.589271 43.665975, 1.298502 43.665978, 1.298502 43.665978))",
                                "center": "POINT(1.444014 43.600603)"
                            },
                       "instrumentMode": "THR",
                       "orderDeadline": "2021-05-31T02:55:00.099Z",
                       "extendedAngle": false,
                       "acquisitionStartDate": "2021-05-31T11:10:44.099Z",
                       "acquisitionEndDate": "2021-05-31T11:10:45.552Z",
                       "incidenceAngle": 26.3,
                       "segmentKey": "ea60293f38ee6de7542b51f8028bab3244de9e25b9dcb8c7d94095c14ca29d70dbbe78c03462eff457763bc8551c5b66dc0852688bbfd731f7e3e2b00b451e37::[{\"key\":\"acqPeriod\", \"value\":\"2021-05-31T11:10:44.099Z 2021-05-31T11:10:45.552Z\"},{\"key\":\"extendedAngle\", \"value\":false},{\"key\":\"geometryWkt\", \"value\":\"POLYGON((1.298502 43.665978, 1.298175 43.535609, 1.589621 43.53495, 1.589271 43.665975, 1.298502 43.665978, 1.298502 43.665978))\"},{\"key\":\"orderDeadLine\", \"value\":\"2021-05-31T02:55:00.099Z\"},{\"key\":\"maxCloudCover\", \"value\":\"25.0\"},{\"key\":\"maxIncidenceAngle\", \"value\":\"30.0\"}]",
                            "acrossTrackIncidenceAngle": 25.609364414413804
                        },{other possibilities…},
"available": true}] }]}

<segmentKey> will be needed later.

You will receive an error message similar to the following if the AOI size is not correct. Example:

{
  "progCapacities": [
    {
      "mission": "PLEIADES",
      "progTypes": [
        {
          "name": "ONEDAY",
          "mission": "PLEIADES",
          "errors": [
            {
              "code": "ERR_MIN_AOI_AREA",
              "locator": "AOI",
              "message": "24.5"
            }
          ],
          "segments": [],
          "available": false
        }
      ]
    }
  ]
}                      

Step 7: Calculate Price for a tasking

Calculate the price for a tasking thanks to this request:

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

Body request sample Pleiades Tasking OneDay: The segmentKey is the segmentKey value of the selected acquisition from the attempt request. For options you have to add all the <key,value> categories mandatories from the options endpoint response with the chosen productTypeId.

{
    "aoi": [
        {
            "id": 1,
            "name": "PHR 1",
            "geometry": {
                "type": "Polygon",
                "coordinates": [[[1.3763809204101562,43.545313140623726 ],[ 1.5095901489257812,43.545313140623726],[1.5095901489257812,43.656198305413156],[1.3763809204101562,43.656198305413156],[1.3763809204101562,43.545313140623726]]]
            }
        }
    ],
    "programReference": null,
    "contractId": "<CisContractId>",
    "items": [
        {
            "productTypeId": "PleiadesTaskingOneDay",
            "aoiId": 1,
            "properties": [
                {
                    "key": "extendedAngle",
                    "value": true
                },
                {
                    "key": "comments",
                    "value": "Pleiades OneDay"
                }
            ],
            "comments": "your comment",
            "segmentKey": "<segmentKey>"
        }
    ],
    "primaryMarket": "NQUAL",
    "secondaryMarket": null,
    "customerReference": "unique customer reference",
    "optionsPerProductType": [
        {"productTypeId": "PleiadesTaskingOneDay",
            "options": [
                {
                    "key": "spectral_processing",
                    "value": "pansharpened_natural_color"
                },
                {
                    "key": "radiometric_processing",
                    "value": "basic"
                },
                {
                    "key": "image_format",
                    "value": "dimap_jpeg2000_regular"
                },
                {
                    "key": "pixel_coding",
                    "value": "8bits"
                },
                {
                    "key": "processing_level",
                    "value": "ortho"
                },
                {
                    "key": "projection_1",
                    "value": "4326"
                },
                {
                    "key": "licence",
                    "value": "eula_5"
                },
                {
                    "key": "dem",
                    "value": "best_available"
                }
            ]
        }
    ],
    "delivery": {
        "type": "network",
        "workspace": "<workspaceId>"
    }
}

Response Pleiades Tasking OneDay

{
    "contractId": "<CisContractId>",
    "currency": "EUR",
    "discountPercentage": 0.0,
    "discountValue": 0.0,
    "productTypes": [{
            "amount": 7392.0,
            "areaKm2": 132.0,
            "discountPercentage": 0.0,
            "discountValue": 0.0,
            "price": 7392.0,
            "productTypeId": "PleiadesTaskingOneDay",
            "items": [{datastripIds": []}
            ],
            "voucherCode": null}],
    "totalAmount": 7392.0 
}

Body request sample Spot Tasking OnePlan

Use feasibilityAutomation ,feasibilityAutomationName and classification from the feasibility response.

{
"aoi": [
    {
     "id": 1,
     "name": "Polygon 1",
     "geometry": {
         "type": "Polygon",
         "coordinates": [ [[ 1.4316558837890625, 43.568824930165476],[ 1.4316558837890625, 43.601900054609445],[ 1.4670181274414062, 43.601900054609445],[ 1.4670181274414062, 43.568824930165476],[ 1.4316558837890625, 43.568824930165476] ] ]
            }
        }
    ],
    "contractId": "<CisContractId>",
    "items": [
        {
            "productTypeId": "SpotTaskingOnePlan",
            "dataSourceIds": [],
            "aoiId": 1,
            "properties": [

                {
                    "key": "acquisitionMode",
                    "value": "MONO"
                },
                {
                    "key": "classification",
                    "value": "CHALLENGING"
                },
                {
                    "key": "feasibilityAutomation",
                    "value": "AUTOMATIC"
                },
                {
                    "key": "notificationThreshold",
                    "value": 25
                },
                {
                    "key": "maxCloudCover",
                    "value": 10
                },
                {
                    "key": "maxIncidenceAngle",
                    "value": 50
                },
                {
                    "key": "acqPeriod",
                    "value": "2021-06-18T09:04:16.284Z 2021-07-18T23:59:59.999Z"
                },
                {
                    "key": "comments",
                    "value": "comment"
                },
                {
                    "key": "feasibilityAutomationName",
                    "value": "AutomaticTasking30"
                }
            ],
            "comments": "comment"
        }
    ],

    "customerReference": "customer reference",
    "optionsPerProductType": [
        {
            "licence": "",
            "productTypeId": "SpotTaskingOnePlan",
            "options": [
 see PleiadesTaskingOneDay options
            ]
        }
    ]
}

Spot Tasking OnePlan price response

{
    "contractId": "<CisContractId>",
    "currency": "EUR",
    "discountPercentage": 0.0,
    "discountValue": 0.0,
    "productTypes": [
        {
            "amount": 690.0,
            "areaKm2": 500.0,
            "discountPercentage": 80.0,
            "discountValue": 0.0,
            "price": 3450.0,
            "productTypeId": "SpotTaskingOnePlan",
            "items": [{"datastripIds": []}],
            "voucherCode": null
        }
    ],
    "totalAmount": 690.0
}

Step 8: Order the tasking

Order your tasking:

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

The body request is the same than the price endpoint. Don’t forget to add:
• delivery type (Available delivery type linked to your contract)
You will need to put your workspaceId (See step 2)
• your email address in order to get notification for acquisition, inside items
• Your primarymarket and secondaryMarket ( example in Response a list of markets ).
• Even if it is not mandatory, it is highly recommanded to use a not null and unique customer reference, it will be useful later to search your order.

"delivery": {
        "type": "network",
        "workspace": "<workspaceId>"
        "notifications": [
        {
          "name": "",
          "channels": [
            {
              "type": "email",
              "parameters": {
                "addresses": [
                  "my_mail@domain.com"
                ]
              }
            }
          ],
          "filter": {
            "events": [
              "ACQUISITION_RECEIVED"
            ]
          }
        }
      ],

Body request sample:

{
  "aoi": [
    {
      "id": 1,
      "name": "Polygon 1",
      "geometry": {
         "type": "Polygon",
        "coordinates": [[ [ 120.488026159467253, -24.571714292158521, 0.0 ], [ 120.491482765150906, -24.733310607869488, 0.0 ], [ 120.66527496805864, -24.729593127593393, 0.0 ], [ 120.661818362374987, -24.567996811882427, 0.0 ], [ 120.488026159467253, -24.571714292158521, 0.0 ] ]]
      }
    }
  ],
  "programReference": null,
  "contractId": "<CisContractId>",
  "items": [
    {
      "notifications": [
        {
          "name": "",
          "channels": [
            {
              "type": "email",
              "parameters": {
                "addresses": [
                  "my_mail@domain.com"
                ]
              }
            }
          ],
          "filter": {
            "events": [
              "ACQUISITION_RECEIVED"
            ]
          }
        }
      ],
      "productTypeId": "PleiadesTaskingOneNow",
      "dataSourceIds": [

      ],
      "aoiId": 1,
      "properties": [
        {
          "key": "extendedAngle",
          "value": true
        },
        {
          "key": "maxCloudCover",
          "value": 10
        },
        {
          "key": "orderDeadLine",
          "value": "2020-06-19T03:30:00.899Z"
        },
        {
          "key": "comments",
          "value": "check if properties relevant between segmentKey"
        },
        {
          "key": "acqPeriods",
          "value": "2020-06-19T10:05:54.899Z 2020-06-19T10:05:56.150Z,2020-06-20T09:58:50.299Z 2020-06-20T09:58:51.550Z,2020-06-21T10:39:32.899Z 2020-06-21T10:39:34.150Z"
        }
      ],
      "comments": "API",
     "segmentKey": "<segmentKey>"
    }
  ],
  "primaryMarket": "NQUAL",
  "secondaryMarket": null,
  "customerReference": "unique customer reference",
  "optionsPerProductType": [
    {
      "licence": "",
      "productTypeId": "PleiadesTaskingOneNow",
      "options": [
        {
          "key": "spectral_processing",
          "value": "bundle"
        },
        {
          "key": "radiometric_processing",
          "value": "display"
        },
        {
          "key": "image_format",
          "value": "dimap_geotiff"
        },
        {
          "key": "pixel_coding",
          "value": "8bits"
        },
        {
          "key": "processing_level",
          "value": "ortho"
        },
        {
          "key": "projection_1",
          "value": "4326"
        },
        {
          "key": "licence",
          "value": "eula_5"
        },
        {
          "key": "dem",
          "value": "best_available"
        }
      ]
    }
  ],
  "delivery": {
    "type": "network",
    "workspace": "<workspaceId>"
  }}


Response

{
    "salesOrderId": " salesOrderId ",
    "currency": "EUR",
    "discountPercentage": 0,
    "discountValue": 0,
    "totalAmount": 20790
}

Step 9: Get your image once delivered

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

API Endpointapi/v1/opensearch?workspaceid=<workspace-Id>
REST verbGET
AuthenticationBearer access token

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

More Options

Available delivery type linked to your contract

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

API Endpointapi/v1/contracts/<CisContractId>/deliveryTypes
REST verbGET
AuthenticationBearer access token

You will receive the following:

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

FTP refers to File Transfer Protocol. NETWORK means that the image will be delivered in your private workspace.

Get markets

API Endpoint/api/v1/<cisContractId>/properties
REST verbGET
AuthenticationBearer access token

Response a list of markets

{"properties": [],
 "markets": [
        {
            "id": "AGRI",
            "label": "Agriculture",
        },
        {
            "id": "GENIE",
            "label": "Civil engineering",
            "secondaryMarket": [
                {
                    "id": "GENIE",
                    "label": "Civil engineering"
                }},
            ]
}

Track your tasking

You can see all your taskings thanks to this request:

API Endpoint/api/v1/<cisContractId>/taskings
REST verbGET
AuthenticationBearer access token

To see the status of a dedicated tasking, you can use the following endpoint after having retrieved the <taskingId>. The taskingId will be available in the email notification received under ICR_ID.

API Endpoint/api/v1/contracts/<cisContractId>/taskings<taskingId>
REST verbGET
AuthenticationBearer access token

<taskingId> is the id under icr.


Reference:

API Endpointapi/v1/contracts/<cisContractId>/taskings?customerRef=yourCustomerReference
REST verbGET
AuthenticationBearer access token

You will receive the following:

{
    "taskings": [
        {
            "sal": "SALXXXXXX",
            "so": "SOXXXXX",
            "icr": {
                "id": "ICR_FC_XXXXX",
                "aoi": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                122.680848001114,
                                -24.4983000806924
                            ],
                            [
                                122.837192701615,
                                -24.494335091697
                            ],
                            [
                                122.834119286537,
                                -24.3386542248409
                            ],
                            [
                                122.6804797677,
                                -24.3373016179506
                            ],
                            [
                                122.680848001114,
                                -24.4983000806924
                            ]
                        ]
                    ]
                },
                "progTypeName": "OneDay",
                "status": "Completed",
                "nbProposedSegments": 0,
                "nbTotalSegments": 0,
                "period": {
                    "startDate": "2021-03-03T01:54:44Z",
                    "endDate": "2021-03-03T02:24:47Z"
                },
                "seriesInformation": null,
                "customerRef": "customer ref",
                "taskingProgress": {
                    "orderedArea": 275718686.400068,
                    "validatedArea": 0.0
                },
                "attempts": "2021-03-03T02:09:44.999Z 2021-03-03T02:09:47.001Z"
            }} ]
}

Get tasking segments

API Endpoint/api/v1/contracts/<CisContractId>/taskings/<taskingId>/segments
REST verbGET
AuthenticationBearer access token

Response:

{
    "segments": [
        {
            "id": "AS_FC_XXXX_1_2",
            "status": "Proposed",
            "asDetail1": {
                "catalogId": "DS_PHR1B_XXXXXX",
                "footprint": {
                    "type": "Polygon",
                    "coordinates": 
                },
                "incidenceAngle": 15.1072,
                "clearSkyRate": 88.8973,
                "acquisitionDate": "2021-04-18T10:53:38Z"
            }}]
}

Export SegmentId

Accept or refuse a segment

Once an order is confirmed, users can begin requesting information about the progress of their requests. For example, if you have tasked OnePlan, every time a validated acquisition is made of your AOI, then the percentage of completion of your tasking is updated accordingly. You can also accept or reject new acquisitions. During the tasking observation period, proposed acquisitions become available. Proposed acquisitions are recently acquired images, which are close to the requested criteria but don’t perfectly match them. For example, the proposed acquisition might have more cloud coverage than you initially specified. In this case, the customer has two possibilities: Validate the image or reject the image.

You can then accept a segment thanks to the following request:

API Endpoint/api/v1/contracts/<CisContractId>/taskings/<tasking_Id>/segments/<segmentId>/accept
REST verbPOST
AuthenticationBearer access token

You can refuse a segment thanks to this one:

API Endpoint/api/v1/contracts/<CisContractId>/taskings/<taskingId>/segments/<segmentId>/refuse
REST verbPOST
AuthenticationBearer access token

Cancel a tasking

You have the possibility to cancel the tasking through:

API Endpoint/api/v1/contracts/<CisContractId>/taskings/<taskingId>/cancel
REST verbPOST
AuthenticationBearer access token

Get license

API Endpoint/api/v1/contracts/<CisContractId>/licences/<licence_Id>
REST verbGET
AuthenticationBearer access token

Glossary

Bundle (Panchromatic + Multispectral) Our Bundle product contains 2 different image files, each with a “native” resolution. 1 Panchromatic image (high-resolution, black and white). Pixel size: 0,5m for Pléiades and 1,5m for SPOT 6/7 Band: Black & white 1 Multispectral image (lower resolution, coloured: Red, Green, Blue and Near Infrared bands) Pixel size: 2m for Pléiades and 6m for SPOT 6/7 Bands: Red, Green, Blue, Near Infrared Example use cases: pansharpening, image correction (for imagery professionals), vegetation analysis, etc.


Display Display level products are generated based on a new algorithm based on the Reflectance product. The aim of the display option is to provide imagery that has been spectrally corrected and that is easy to display in true color in their software applications. Display processing is to be used when imagery needs to be immediately usable with optimized visual rendering.


Geographic projection A Geographic projection is a simple mapping projection based on a reference ellipsoid model of the Earth (WGS 84) to convert the coordinates to a planar system as angular coordinates (latitude / longitude). Main benefit: Preserve shape Best suited for wide coverage


GeoTIFF GeoTIFF files are free of any compression. GeoTIFF is based on the standard TIFF format that can be opened on most devices with no specific set up. The additional georeferenced information contained in the GeoTIFF file can be used on any GIS.


Incidence Angle quicklook


JPEG 2000 Jpeg2000 files are smaller than GeoTIFF files. File compression has no impact on image quality, and is completely reversible. Jpeg2000 is an advanced format that can be opened via simple tools (GIMP, photoshop). Main benefit: Lighter image file Example use cases: post-processing, streaming, etc.


Orthorectification Orthorectification aims at applying geometric corrections that will display the image in a way that the pixels of the image are in an accurate position on the ground.


Panchromatic High-resolution, black and white image


Pansharpened Pansharpened results from the merging of the high-resolution Panchromatic and the lower resolution Multispectral imagery to create a single high-resolution colour image.


Reflectance Reflectance products are corrected from sensor calibration and systematic atmospheric effects. Clouds, cloud veil, haze, aerosol (pollution and sandstorm) remain. Images with a Reflectance processing are provided with the coefficients to reverse back to the Basic images, as well as the coefficients to convert into Display images.


Resolution Spatial resolution is defined as the pixel size of an image.


Tasking Tasking allows users to submit a satellite tasking request over an area of interest and to obtain the imagery they requested.


UTM projection The Universal Transverse Mercator (UTM) projection is also based on a reference ellipsoid model of the Earth (WGS 84). It differs from the Geographic projection in that it divides the Earth into 60 zones and projects each to the plane as a basis for its coordinates. Depending on your Area of Interest, you are proposed the most suitable zones for your projection. Main benefits: Preserve distance and area Native metrics (meters) Best suited for small areas

Contact Us