Saltar al contingut

Castellano Català

API d'incolonias

API REST per exportar les dades del programa de colònies felines i integrar-les amb la plataforma municipal de gestió de dades, un sistema GIS o un portal de dades obertes.

Especificació OpenAPI 3.0

Autenticació

Cada entitat crea les seves claus a «Configuració › API». Envia la clau a la capçalera:

Authorization: Bearer icol_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Si tu sistema no puede enviar esa cabecera, usa X-API-Key con la misma clave.

Una clau només veu les dades de la seva entitat. Es pot revocar a l'instant. Límit: 600 peticions per minut.

Recursos

Paràmetres comuns:

Indicadors

GET /api/v1/estadisticas/{indicador}?meses=12&zona_id=

Crear avisos

Amb una clau amb permís «avisos», un altre sistema (el 010, la bústia ciutadana) pot crear avisos:

POST /api/v1/avisos
Content-Type: application/json

{"tipo": "gato_herido", "descripcion": "Gato cojeando junto al parque", "lat": 41.542, "lon": 2.267}

Tipus admesos: gato_herido, gato_enfermo, gato_fallecido, camada, abandono, envenenamiento, conflicto_vecinal, suciedad, otro

Exemple

curl -H "Authorization: Bearer $CLAVE" "https://app.incolonias.es/api/v1/colonias?por_pagina=100"
{
  "recurso": "colonias", "total": 21, "pagina": 1, "paginas": 1, "por_pagina": 100, "siguiente": null,
  "datos": [{"id": 1, "codigo": "COL-0001", "nombre": "…", "lat": 41.54, "lon": 2.26, "utm_x": 438861.13, "utm_y": 4599186.41, "utm_huso": 31,
             "gatos_presentes": 12, "gatos_esterilizados": 9, "estado": "autorizada", …}]
}

incolonias · gestió de colònies felines · incolonias.es