Referencia

Catálogos

Os valores que o resto da API aceita. Leia primeiro: um reportType ou uma estatística inventada é recusado com uma mensagem que nomeia o campo mas não o conjunto válido.

GET/api/v2/catalogs/report-types

Os valores de reportType válidos por tipo de análise, com id, etiqueta e estatísticas associadas.

Resposta

json
{
  "counting": [
    {
      "id": "3146878f-39c3-44f1-8a95-f2a17170a1d9",
      "key": "NDRE",
      "label": { "en": "NDRE", "es": "NDRE" },
      "statistics": ["viGlobalMedian", "viTotalPlants"],
      "reportCategory": "vegetation_index"
    }
  ],
  "replanting": [],
  "path": []
}

A tener en cuenta

  • O super admin da Kaax edita esta lista, então não a fixe no código: leia-a.
  • `key` é o que vai em `reportType`; `id` é o que vai em `reportTypeId`.
GET/api/v2/catalogs/statistics

As chaves de estatística que existem por tipo de análise — o conjunto de onde selectedStatistics deve sair.

GET/api/v2/catalogs/vegetation-index-defaults

Tudo o que é necessário para montar um template de índice de vegetação sem adivinhar: nomes de índice, escalas de cor calibradas, layouts padrão e a whitelist de fórmulas.

Resposta

json
{
  "indexNames": ["NDVI", "NDWI", "EVI", "SAVI", "NDRE", "LCI", "Custom_Index"],
  "colorScales": { "NDRE": [ /* … */ ] },
  "accentColors": { "NDRE": "#27AE60" },
  "layouts": { "portrait": { /* … */ }, "landscape": { /* … */ } },
  "defaults": {
    "paperSize": "letter",
    "mapResolution": 150,
    "margins": { "top": 2, "right": 2, "bottom": 2, "left": 2 },
    "saviL": 0.5
  },
  "customFormula": {
    "allowedBands": ["R", "G", "B", "RE", "NIR"],
    "allowedScalars": ["eps", "L"],
    "allowedFunctions": ["sqrt", "abs"],
    "rules": { "divisionRequiresEps": true }
  }
}

A tener en cuenta

  • `mapResolution` vem como número. Copiá-lo como texto ("150") é recusado pelo TIPO, e a mensagem nomeia o campo mas não a razão.