Skip to content
English
Wildfire Solution App
  • There are no suggestions because the search field is empty.

Setting up APIs


If you want to integrate WFS to your own system, an API Key is required. For this, a valid subscription is required. Contact our team for more information support@ororatech.com.


All data present in WFS is accessible via the Web App or via API.

The API provide direct access to the data and functionalities of the platform, and it is the recommended way to integrate the platform into existing systems.

Introduction


For any API operation, an API key is required. The key must be included in the request header as apikey.

The pull-based API offered as part of the Wildfire Solution include a set of HTTPS REST endpoints that allow users to:

  • retrieve data about active & historical fires
  • retrieve data about burnt areas (caused by fires)
  • run fire spread simulations
  • task images from OroraTech's satellites
  • query satellite products

To use the API, users need an active subscription, an API key and a REST client to request data from the server. The server processes the request and returns the requested data according to the specified parameters.

Authorization​

Authorization with the API is achieved through personal API keys. Logged-in users with a valid subscription can generate a personal API key through the "Account -> Profile" section.

apisc

After generating a key, the key must be stored in a secure place. It will not be possible to view the key again on the platform. If a key is lost, the old one must be deleted and a new one be generated. Deleted keys are revoked and will stop working immediately.

All requests to the API must include this key within an apikey header, for example:

curl --request GET \
  --url "https://app.ororatech.com/v1/monitored_areas/my/clusters/" \
  --header "apikey: ot_1234567890abcdef.1234567890aBCDef"
 API keys will stop working whenever a subscription expires, although the key itself will not be deleted. If a subscription is renewed, the same key can be used again.

It is recommended to stop automated jobs when a subscription is about to expire, to avoid unnecessary API requests and to prevent the API key from being blocked.

Limitations​

Depending on the subscription plan, users may have access to different features and may be subject to different rate limits. In some cases, only a specific time window of data may be available (e.g. fire data from a specific year). Contact your sales partner to get more information about the available features and limitations.

Refer to the Integration Guides section for more information on how often to poll an API, in order to retrieve data effectively without overusing the API.

Specification​

The REST API specification is optionally offered as a Swagger file. The swagger file can be used to generate client code for various programming languages. The swagger file is available at the following URL: https://app.ororatech.com/v1/api/swagger.json.


In this link, you can find all the REST API documentation for further data extraction in Fire, Burnt Areas, Integrated Incidents, Fire Spread, and many other topics.