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 Download Links

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.

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