Si deseas integrar la solución Wildfire Solution (WFS) a tu propio sistema, es necesario contar con una clave API. Para obtenerla, se requiere una suscripción válida. Contacta con nuestro equipo para más información.
Toda la información disponible en WFS es accesible a través de la Web App o mediante API. La API ofrece acceso directo a los datos y funcionalidades de la plataforma y es el método recomendado para integrar la solución en sistemas existentes.
Introducción
Para cualquier operación con la API, se requiere una clave API. Esta clave debe incluirse en el encabezado de la solicitud como apikey.
La API basada en extracción (pull-based) que forma parte de la Solución Wildfire incluye un conjunto de puntos finales REST HTTPS que permiten a los usuarios:
- Recuperar datos sobre incendios activos e históricos.
- Obtener datos sobre áreas quemadas (causadas por incendios).
- Ejecutar simulaciones de propagación de incendios.
- Solicitar imágenes de los satélites de OroraTech.
- Consultar productos satelitales.
Uso de la API
Para usar la API, los usuarios necesitan:
- Una suscripción activa.
- Una clave API.
- Un cliente REST para realizar las solicitudes de datos al servidor.
El servidor procesa la solicitud y devuelve los datos solicitados según los parámetros especificados.
Autorización
La autorización con la API se realiza mediante claves API personales. Los usuarios con sesión iniciada y una suscripción válida pueden generar una clave API personal en la sección "Cuenta -> Perfil".
Tras generar la clave, debe almacenarse de forma segura, ya que no será posible ver la clave nuevamente en la plataforma. Si la clave se pierde, debe eliminarse la clave antigua y generar una nueva. Las claves eliminadas se revocan y dejan de funcionar inmediatamente.
Todas las solicitudes a la API deben incluir esta clave en el encabezado apikey, por ejemplo:
curl --request GET \
--url "https://app.ororatech.com/v1/monitored_areas/my/clusters/" \
--header "apikey: ot_1234567890abcdef.1234567890aBCDef"
Expiración de la clave API
Las claves API dejarán de funcionar cuando expire la suscripción, aunque la clave no se eliminará. Si se renueva la suscripción, se puede usar la misma clave nuevamente.
Se recomienda detener los trabajos automatizados cuando la suscripción esté a punto de caducar, para evitar solicitudes innecesarias y prevenir que la clave API sea bloqueada.
Limitaciones
Dependiendo del plan de suscripción, los usuarios pueden tener acceso a diferentes características y estar sujetos a distintos límites de tasa. En algunos casos, solo puede estar disponible un conjunto de datos para una ventana temporal específica (por ejemplo, datos de incendios de un año en particular). Contacta a tu socio comercial para obtener más detalles sobre las características y limitaciones disponibles.
Consulta la sección de Guías de Integración para obtener más información sobre la frecuencia recomendada de las consultas API, para extraer datos de manera eficiente sin exceder los límites de uso.
Especificación REST
La especificación REST de la API se ofrece opcionalmente como un archivo Swagger. Este archivo puede utilizarse para generar el código del cliente para varios lenguajes de programación. El archivo Swagger está disponible en la siguiente URL:
https://app.ororatech.com/v1/api/swagger.json.
En este enlace, encontrarás toda la documentación de la API REST para la extracción de datos relacionados con incendios, áreas quemadas, incidentes integrados, propagación de incendios y muchos otros temas.