EO Platform

Appearance

Quick Start Guide for Satellite Imagery Ordering Platform API Integration ​

1. API Key Usage ​

  • All APIs require an API Key for authentication. You need to contact the platform system administrator to obtain your API Key.
  • Include the API Key in the HTTP request header:
bash
-H "X-API-Key: YOUR_API_KEY_HERE"
  • The Host for HTTP requests is:
bash
https://eo-imagery.origen.ae/market_service
  • Example API request:
bash
curl -X POST "https://eo-imagery.origen.ae/market_service/market/page/query" \
     -H "X-API-Key: YOUR_API_KEY_HERE"

2. Module Overview ​

The platform provides the following core API modules for imagery search, order management, and task creation:

2.1 Existing Images ​

  • Purpose: Search existing satellite imagery on the platform and add selected images to the shopping cart.

  • Key APIs:

    • Query Existing Images (/market/page/query): Search for existing imagery on the platform.
    • Add Images To Cart (/market/shoppingCart/addProduct): Add selected images to the shopping cart.

2.2 My Cart ​

  • Purpose: Manage images already added to your shopping cart.

  • Key APIs:

    • Remove Existing Images From Cart (/market/shoppingCart/removeProduct): Remove images from the shopping cart.
    • Query Existing Images from Cart (/market/shoppingCart/query): Retrieve the list of images in your shopping cart.

2.3 My Orders ​

  • Purpose: Create and query image orders.

  • Key APIs:

    • Create Existing Images Order (/market/order/create): Create an order for images in your shopping cart.
    • Query Orders (/market/order/page/query): Query the list and status of your orders.
    • Query Order Details (/market/order/detail): View detailed information about an order.
    • Get Order Download Links (/market/order/downloadLinks): Get order output download links.
    • Query Parent Order Children (/market/order/parent/children): Query child orders under a parent order.
    • Update Recurring Order Running Status (/market/order/recurring/running): Enable or disable recurring order execution.
    • Create Simulation Task By Order No (/market/order/programming/simulation/createByOrderNo): Create a simulation task from an existing order.
    • Create Order From Simulation By Order No (/market/order/programming/createFromSimulationByOrderNo): Create a programming order from simulation results by order number.
    • Update Order Output Storage (/market/order/outputFolder/update): Update the output storage location for an order.
    • Query AOI With Order Count (/market/aoi/queryWithOrderCount): Query AOI list with related order counts.

2.4 Order New Image ​

  • Purpose: Submit a new imaging task for custom images that do not yet exist on the platform.

  • Key APIs:

    • Create New Images Order (/market/order/programming/create): Create a new custom imagery order.
    • Create Simulation Task (/market/order/programming/simulation/create): Create a simulation task before placing a programming order.
    • Query Simulation Task Result (/market/order/programming/simulation/results): Query simulation task execution status and candidate results.
    • Create New Images Order From Simulation (/market/order/programming/createFromSimulation): Create a programming order from simulation result IDs.
    • Query OSS Output Config List (/market/ossOutput/list): Query available output storage configuration options.

3. Usage Scenarios ​

Scenario 3.1: Purchase Existing Imagery ​

Flow: 1. Search Images → 2. Add to Cart → 3. Create Order → 4. Query Order Status → 5. Get Order Download Links

1. Query Existing Images

http
POST /market/page/query
  • Response: List of images and basic information

2. Create Order

http
POST /market/order/create
  • Response: Order ID for subsequent queries

3. Query Order Status

http
POST /market/order/detail
  • Response: Order status (Processing, Completed, Failed, etc.)

5. Get Order Download Links

http
POST /market/order/downloadLinks
  • Request Body:
json
{
    "orderNo": "ORDER_202310270001"
}
  • Response: Order status and download URLs (available when status is delivered or completed)

Note: This step can only be used when the previous step's order status returns 2 (Delivered).

Scenario 3.2: Create New Imagery Order ​

Flow: 1. Create New Image Order → 2. Query Order Details → 3. Get Order Download Links

1. Create New Image Order

http
POST /market/order/programming/create
  • Response: Order ID

2. Query Order Details

http
POST /market/order/detail
  • Response: Task status (Pending, In Progress, Completed, Failed, etc.)

3. Get Order Download Links

http
POST /market/order/downloadLinks
  • Request Body:
json
{
    "orderNo": "ORDER_202310270001"
}
  • Response: Order status and download URLs (available when status is delivered or completed)

Note: This step can only be used when the previous step's order status returns 2 (Delivered).

Scenario 3.3: Create New Imagery Order From Simulation ​

Flow: 1. Create Simulation Task → 2. Poll Simulation Results → 3. Create Programming Order From Simulation → 4. Query Order Details → 5. Get Order Download Links

1. Create Simulation Task

http
POST /market/order/programming/simulation/create
  • Response: Simulation task number (taskNo) for result polling

2. Poll Simulation Results

http
POST /market/order/programming/simulation/results
  • Response: Simulation status and candidate result IDs (content[].id)
  • Action: Continue polling until status indicates completion

3. Create Programming Order From Simulation

http
POST /market/order/programming/createFromSimulation
  • Request: Use one or more result IDs returned by the simulation results API
  • Response: Order ID for subsequent status and download queries

4. Query Order Details

http
POST /market/order/detail
  • Response: Task status (Pending, In Progress, Completed, Failed, etc.)

5. Get Order Download Links

http
POST /market/order/downloadLinks
  • Request Body:
json
{
    "orderNo": "ORDER_202310270001"
}
  • Response: Order status and download URLs (available when status is delivered or completed)

Note: This step can only be used when the previous step's order status returns 2 (Delivered).

Scenario 3.4: Create Recurring Order ​

Flow: 1. Create Recurring Order → 2. Query Parent Order Children → 3. Query Child Order Details → 4. Get Order Download Links

1. Create Recurring Order

http
POST /market/order/create
  • Request: Submit order parameters in recurring mode (such as recurring rule, recurring period, and schedule settings)
  • Response: Parent order number (orderNo)

2. Query Parent Order Children

http
POST /market/order/parent/children
  • Request: Use the parent order number from Step 1
  • Response: Child order list and each child orderNo

3. Query Child Order Details

http
POST /market/order/detail
  • Request: Use the child orderNo from Step 2
  • Response: Child order status (Processing, Completed, Failed, etc.)

4. Get Order Download Links

http
POST /market/order/downloadLinks
  • Request Body:
json
{
    "orderNo": "CHILD_ORDER_202310270001"
}
  • Response: Order status and download URLs (available when status is delivered or completed)

Note: This step can only be used when the previous step's order status returns 2 (Delivered).