Skip to main content

Best Practices & General Guidance

Basic Guidance

  • Orders are machine to machine in almost all cases.
    • Archive orders in particular cannot be cancelled once placed and will not be subject to any refund requests for accidental placement via the API.
    • As a general rule tasking orders can usually be cancelled provided they are not committed for collection on the providers side. To cancel a tasking you must contact the Support Team (support@skywatch.com) a minimum of 48 hours before the start of the order. Longer notice is preferred to ensure the tasking can be cancelled.
  • Some API calls require a specific account type.
    • Reader accounts for example cannot create orders or projects but can access results, while Super Admin accounts can do both as well as make additional API calls for organizational management (user and project creation or updates).

AOI Rules

  • Single Polygon (WGS84), no holes (donuts) or multipolygons.
  • AOIs with fewer than 200 vertex pairs are recommended, automated AOI simplification may occur with >200 vertices.
  • Valid geometry is required, no self-intersections or non-closed rings.
  • Minimum AOI size for archive is > 1 km². Some archive sources have a minimum billable area that exceeds the minimum geometry requirements, this will be reflected in the archive result details and cost.
  • Tasking orders will vary per source for both minimum geometry and minimum billable area requirements.
    • Minimum geometry for tasking sources is accessible through the offering search call, while minimum billable area is accessible through the cost calculation call.
    • Tasking orders must meet the minimum geometry requirement and have the correct cost applied that reflects the minimum billable area to be successfully created.
  • Prefer test calls with Sentinel-2 (free) first to avoid charges. Archive orders placed via API are machine-to-machine and are not refunded. Tasking orders cannot be canceled within 48h of start.

Safe Sandbox Testing

  • Enabling order approvals in the Hub organization and ordering with an account type that is subject to approvals (Creator or Admin) is a great way to test the API with no risk of charges.
    • Orders placed by accounts requiring approval are blocked from submission until accepted by a Super Admin.
    • Even with approvals enabled Super Admin accounts are not subject to approvals, orders placed with Super Admin API keys will automatically be approved and submitted.
  • For basic archive API testing it is recommended that free to use Sentinel-2 data be utilized.
    • Sentinel-2 has no cost and can be used to gain an understanding of the archive ordering process.
    • Free data sources like Sentinel-2 are not subject to approvals and will be automatically accepted.
  • For tasking order testing making use of approvals is recommended, tasking orders can then be placed without being automatically accepted.
    • You can then check with out Support Team to confirm if the tasking order body contains any errors that would prevent successful placement.
    • Additionally you can coordinate with the Support Team, then place and accept taskings well in advance of the start date. This will give them enough time to review the tasking order body and to cancel the order with the providers before it is committed for collections.