Se você quiser integrar o WFS ao seu próprio sistema, será necessária uma chave de API. Para isso, é necessário ter uma assinatura válida. Entre em contato conosco para obter mais informações.
Todos os dados presentes na WFS podem ser acessados por meio do Web app ou API.
A API fornece acesso direto aos dados e às funcionalidades da plataforma, e é a maneira recomendada de integrar a plataforma aos sistemas existentes.
Introdução
Para qualquer operação de API, é necessária uma chave. A chave deve ser incluída no cabeçalho da solicitação como apikey.
A API baseada em pull oferecida como parte da solução Wildfire inclui um conjunto de pontos de extremidade HTTPS REST que permitem aos usuários
- recuperar dados sobre incêndios ativos e históricos
- recuperar dados sobre áreas queimadas (causadas por incêndios)
- executar simulações de propagação de incêndios
- realizar tarefas de imagens dos satélites da OroraTech
- consultar produtos de satélite
Para usar a API, os usuários precisam de uma assinatura ativa, uma chave de API e um cliente REST para solicitar dados do servidor. O servidor processa a solicitação e retorna os dados solicitados de acordo com os parâmetros especificados.
Autorização
A autorização com a API é obtida por meio de chaves de API pessoais. Os usuários conectados com uma assinatura válida podem gerar uma chave de API pessoal na seção “Conta -> Perfil”.
Depois de gerar uma chave, ela deve ser armazenada em um local seguro. Não será possível visualizar a chave novamente na plataforma. Se uma chave for perdida, a antiga deverá ser excluída e uma nova deverá ser gerada. As chaves excluídas são revogadas e deixarão de funcionar imediatamente.
Todas as solicitações para a API devem incluir essa chave em um cabeçalho apikey, por exemplo:
curl --request GET \
--url "https://app.ororatech.com/v1/monitored_areas/my/clusters/" \
--header "apikey: ot_1234567890abcdef.1234567890aBCDef"
Recomenda-se interromper os trabalhos automatizados quando uma assinatura estiver prestes a expirar, para evitar solicitações de API desnecessárias e impedir que a chave de API seja bloqueada.
Limitações
Dependendo do plano de assinatura, os usuários podem ter acesso a diferentes recursos e podem estar sujeitos a diferentes limites de taxa. Em alguns casos, apenas uma janela de tempo específica de dados pode estar disponível (por exemplo, dados de incêndio de um ano específico). Entre em contato com o seu parceiro de vendas para obter mais informações sobre os recursos e as limitações disponíveis.
Consulte a seção Guias de integração para obter mais informações sobre a frequência de sondagem de uma API, a fim de recuperar dados de forma eficaz, sem usar demais a API.
Especificação
A especificação da API REST é oferecida opcionalmente como um arquivo Swagger. O arquivo swagger pode ser usado para gerar código de cliente para várias linguagens de programação. O arquivo swagger está disponível no seguinte URL: https://app.ororatech.com/v1/api/swagger.json.
Nesse link, você pode encontrar toda a documentação da API REST para extração de dados adicionais em Incêndio, Áreas queimadas, Incidentes integrados, Propagação de incêndio e muitos outros tópicos.