Skip to main content

⚙️ Visão Geral da API

A API Kropie permite aceder aos dados das suas estações e índices agronómicos de forma programática.
Com a API, pode integrar os dados da Kropie em aplicações externas, ferramentas de investigação ou dashboards personalizados.

Este guia cobre os conceitos básicos de autenticação, os endpoints disponíveis e como requisitar dados meteorológicos e índices.

🔑 Acesso à API​

A API Kropie está disponível para utilizadores verificados com uma conta ativa.
Para a utilizar, necessita de uma chave API que autentica os seus pedidos.

Para solicitar acesso:

  1. Contacte [email protected] com o assunto “API Access Request”.
  2. Inclua o seu email de conta e nome da organização.
  3. Receberá a sua chave API e o link para documentação.

A sua chave API identifica-o como utilizador e deve ser incluída em todos os pedidos.

🔐 Autenticação​

Todos os pedidos à API devem incluir a sua chave API no cabeçalho.

Exemplo:

GET https://api.kropie.com/v1/stations Authorization: Bearer YOUR_API_KEY

Nunca partilhe a sua chave API publicamente ou a inclua em código cliente.

🌐 URL Base​

Todos os pedidos usam a seguinte URL base:
https://api.kropie.com/v1/

📡 Endpoints Disponíveis​

A seguir estão os principais endpoints para obter dados de estações e índices agronómicos.

1. Listar Todas as Estações​

Recupera todas as estações meteorológicas ligadas à sua conta Kropie.

GET /stations

Exemplo de Resposta:

[
  {
    "id": "KRP001",
    "name": "Vineyard South",
    "status": "online",
    "latitude": 41.188,
    "longitude": -7.786
  }
]

2. Obter Dados da Estação​

Recupera leituras históricas de uma estação específica.

GET /stations/station_id/data?start=YYYY-MM-DD&end=YYYY-MM-DD

Parâmetros:

NomeTipoDescrição
station_idstringID único da estação
startdateData de início do intervalo de dados
enddateData de fim do intervalo de dados

3. Obter Índices Agronómicos​

Recupera índices calculados, como Winkler, Huglin, Cold Hours e Evapotranspiração.

GET /stations/station_id/indexes?start=YYYY-MM-DD&end=YYYY-MM-DD

Exemplo de Resposta:

4. Obter Dados Mais Recentes​

Recupera as leituras mais recentes de uma estação.

GET /stations/station_id/latest

5. Obter Estado da Estação​

Verifica se uma estação está online ou offline.

GET /stations/station_id/status

🧩 Formato dos Dados​

Todas as respostas são devolvidas em JSON e incluem timestamps em UTC (formato ISO 8601).
Pode facilmente processar estes dados em linguagens como Python, JavaScript ou PHP.

📊 Limites de Requisições​

Para garantir estabilidade, a API Kropie aplica limites de taxa de utilização.

💡 Boas Práticas​

  • Faça cache das respostas para reduzir carga na API e melhorar desempenho.
  • Inclua sempre datas de início e fim para limitar o volume de dados.
  • Use HTTPS para transferências seguras.
  • Evite requisitar intervalos muito longos (divida em intervalos menores se necessário).
  • Roteie a sua chave API regularmente por segurança.

📝 Exemplos de Uso​

  • Criar um dashboard personalizado de vinhedos com dados da Kropie.
  • Automatizar a gestão de irrigação obtendo valores diários de ET₀.
  • Combinar dados de várias estações num relatório climático regional.
  • Integrar leituras da Kropie em plataformas externas de gestão agrícola.