Skip to main content

Key API Principles

In order to start using the SatVu API or SDK, you must have access to the platform. Head to Accessing SatVu platform to find out how to get access.

Authentication​

All our APIs use bearer token authentication, where each authenticated request must be made with an Authorization  header holding a Bearer <token> value.

Details about authentication are provided in the Python SDK and the RESTful API sections accordingly.

To get authentication tokens, you need to obtain User API Credentials from the User profile page.

User profile - retrieving Client ID and Client Secret.

note

Please note tokens are valid for 60 minutes.

Using the contract​

As mentioned in Accessing SatVu platform, the platform requires you to select a contract in order to proceed to the product offerings. On the API level, this is achieved by providing the contract ID in the URL path. Here is an example for the feasibility study endpoints: https://api.satellitevu.com/otm/v2/{contract_id}/tasking/feasibilities/

You can find the contract ID on your Dashboard or use the policy service to retrieve it. The ID is defined as a UUID value.

Dashboard - contract name and ID.

Versioning​

Each API is published at a URL path in the API gateway, i.e. version 2 of the Tasking API is available at: https://api.satellitevu.com/otm/v2/.

Major version changes will be reflected in the API base path with both versions (the current and last major version) being supported concurrently and the update being communicated before the last major version is retired.

Errors​

When the request is not working, we return a dedicated response code. Response codes of 4xx suggest a bad request. We aim to provide additional information in the response message to help you diagnose the issue. 5xx errors suggest a problem on SatVu’s end. In such cases, we recommend communicating with our Customer Support team.