Release notes for API Platform 2.0

New APIs

The following APIs are new in API Platform 2.0:

  • Delivery API — a new API that enables you to request delivery of your tasked products or any products you purchased from the public catalog. See Delivery.

  • Notifications API — a new API for handling asynchronous interactions. The Notifications API enables you to use webhooks to learn when resources are updated in the ICEYE system. See Notifications.

Updated APIs

Tasking API

The following operations have changed in v2:

  • POST /tasking/v2/tasks endpoint — the Create task operation has changed as follows:

    • A new notifications parameter is provided, which you can configure to receive callbacks from the notification service whenever the task status changes.

    • The deliveryLocations parameter has been replaced by the deliveries parameter, which enables you to configure delivery locations in a manner that is consistent with the new Delivery API.

    • The additionalProductTypes parameter has been removed. The SLA products delivered for a tasking request are now managed by your company’s contract and changes to the SLA products can be requested by contacting the COSP team.

  • GET /tasking/v2/tasks/:taskID endpoint — in the Get task operation, the response now includes fields for deliveries and notifications.

  • GET /tasking/v2/tasks/:taskID/products and GET tasking/v2/tasks/:taskID/products/:productType endpoints — in the Get products and Get products by type operations, the response is similar to the Catalog API and includes many additional properties in the product description.

Catalog API

The Catalog API now provides access not just to the public catalog, but also to the private images you have previously tasked (associated with the company of the currently authenticated user).

The following operations are new in v2:

  • GET /catalog/v2/price endpoint — using the Get frame price operation, you can check the price of a frame before purchasing (for contracts that have an associated pricing model).

The following operations have changed in v2:

  • GET /catalog/v2/items endpoint — in the List catalog items operation, the variety of properties that can be provided to the sortby query parameter has been extended and existing property names have been modified to conform to the STAC standard.

    STAC items returned from this operation now include additional properties.

  • POST /catalog/v2/search endpoint — in the Search catalog items operation, the number of different properties you can provide in a STAC metadata query has been extended. See Filtering by STAC metadata query.

    STAC items returned from this operation now include additional properties.

  • POST /catalog/v2/purchases endpoint — in the Purchase frame operation, an image is purchased by frame, not by STAC item. The following changes were made to this endpoint:

    • To purchase a frame, specify the frameID (instead of a list of item IDs).

    • Instead of specifying the companyName and contactPerson parameters, set the optional eula parameter.

    • The response message has a new format, which includes the purchase ID, frame ID, and status.

  • GET /catalog/v2/purchases/:PURCHASE_ID endpoint — in the Get purchase operation, the response message has a new format, which includes the purchase ID and frame ID.

  • GET /catalog/v2/purchases endpoint — in the List purchases operation, the purchase records returned in the response have a new format.

  • GET /catalog/v2/purchases/:PURCHASE_ID/products endpoint — in the List purchase products operation, the format of the STAC items returned from this operation has been modified and extended to include many more properties.

Searchable properties

API Platform 2.0 adds new searchable STAC item properties and updates existing property names to conform to the STAC standards.

The following properties were removed:

  • image_mode — was removed in 2.0. Use sar:instrument_mode instead.

  • incidence_angle — was removed in 2.0. Use iceye:incidence_center instead.

The following properties were renamed to conform to the STAC item specification (using prefixes):

API Platform 1.0 property name API Platform 2.0 property name

start_time

start_datetime

end_time

end_datetime

instrument_mode

sar:instrument_mode

product_type

sar:product_type

observation_direction

sar:observation_direction

orbit_state

sat:orbit_state

incidence_angle

iceye:incidence_center

satellite_look_angle

iceye:satellite_look_angle

polarizations

sar:polarizations

The following STAC item properties were added:

New API Platform 2.0 property

created

updated

sar:frequency_band

sar:looks_range

sar:looks_azimuth

iceye:acquisition_mode

iceye:azimuth_resolution

iceye:range_resolution_center

iceye:range_resolution_near

iceye:range_resolution_far

iceye:incidence_center

iceye:incidence_near

iceye:incidence_far

iceye:chirp_bandwidth

iceye:data_orientation

Documentation website

The API Platform documentation has been migrated to a new website, with the following changes: