Skip to main content

Getting started

Request new satellite imagery over your area of interest with the EarthLife Tasking API.

Overview​

Use the steps below to go from credentials to a tracked tasking request. Select a step for a short summary, then open the full guide when you need curl details.

Authenticate, resolve catalog options (image types and resolutions), create a tasking request, then inspect status.

Obtain a Bearer access token from Auth, then call Gateway endpoints with Authorization.

Go to stepFull guide

Bases​

  • Auth: https://earthlife.sarsatx.com/auth
  • Gateway: https://earthlife.sarsatx.com/gateway

1. Authenticate​

POST /connect/token with client_id=earthlife-tasking-api, your email/password, and scopes including earthlife.orders (add offline_access when you need refresh).

Call Gateway APIs with:

Authorization: Bearer YOUR_ACCESS_TOKEN

Full grant fields, refresh, and errors: Authentication.

2. List image types​

GET /order/Lookup/GetImageTypesList returns catalog image types (optical options such as Multispectral and Daytime, SAR, Stereo, and others).

Example response:

[
  {
    "imageTypeID": 2,
    "nameAr": "خلال النهار",
    "nameEn": "Daytime",
    "previewImage": "",
    "isActive": true,
    "isOpenData": true,
    "isCommercial": true
  },
  {
    "imageTypeID": 3,
    "nameAr": "SAR",
    "nameEn": "SAR",
    "previewImage": "",
    "isActive": true,
    "isOpenData": true,
    "isCommercial": true
  },
]

Curl samples: Catalog.

3. List resolutions​

GET /order/Lookup/GetImageResolutions returns resolution options. Choose a resolution before create and pass its ID with the image type in cartItemDataList (example resolution ID: 4).

Use only an imageResolutionID where "isActive": true. Do not send inactive resolution IDs in the create payload.

Details and examples: Catalog.

4. Create tasking request​

POST /order/Order/CreateOrder with "serviceID": 3 (Tasking service), plus POI, image type, resolution, capture dates, provider, and cloud cover (paymentMethod=1 in the query string as shown in the create guide).

Lifecycle: Tasking concepts.
Full create curl: Create a tasking request.

5. Inspect status​

Track requests with POST /order/Order/GetOrders and GET /order/Order/GetOrderDetails.

Guide: List and inspect orders.

Next steps​