OGP Euskadi API

Documentación del API que tienen que soprtar todos los participantes en el proyecto Kontuematea / OGP Euskadi.

Contenidos

Todo el contenido de un Plan de Mandato está estructurado en dos niveles que definen el plan:

  • Objetivos - los Objetivos forman el primer nivel del Plan del Mandato. A cada Objetivo le corresponde una o varias acciones.

  • Acciones - una Acción es el segundo nivel del Plan del Mandato. Cada Acción pertenece a un Objetivo. A cada acción se asignan uno o varios Indicadores.

Durante el seguimiento del cumplimiento del Plan las novedades se introducen como Actividades que actualizan los valores de los Indicadores corresponientes.

Autenticación

Cada participante dispondrá de un nombre de cliente y un API key que se le asignará por los gestores de la aplicación.

A la hora de realizar peticiones se usará autenticación por token basada en JWT (JSON Web Token).

El cliente tiene que solicitar el token para la sesión usando su nombre y el API key y posteriormente incluir el token que ha recibido en la cabecera de todas las peticiones.

Datos a enviar

Campo Descripción
client Nombre del cliente
api_key API key del cliente

Respuesta

Campo Descripción
token JSON Web Token
GET
/api/v1/auth/access_token

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/auth/access_token -d 'client=obaba&api_key=Zw0jc7Ks7baZl4JY'

Ejemplo de respuesta·

  {
   "token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkaG....."
  }

Peticiones

Todas las peticiones, salvo la que se usa para obtener el JWT, deben incluir la cabecera "Authorization" con contenido "Bearer token"

Respuestas

Todas las respuestas a las peticiones realizadas contendrán un código de estado HTTP.

  • Si la petición se ha realizado correctamente, el código del estado será 2XX.
  • Si ha habdo un error a la hora de realizar la petición el código será 4XX o 5XX según el error.

Objetivos

Los Objetivos son el primer nivel en la definición del Plan de Mandato. Cada objetivo se caracteriza con su:

  • Titulo (en castellano y en euskera) - title_es, title_eu
  • Descripción (en castellano y en euskera) - description_es, description_eu
  • Posición en la lista de objetivos del plan de mandato - position

Además cada Objetivo puede estar en borrador o publicado.

Lista de objetivos

La petición permite obtener el listado de todos los Objetivos del plan que corresponde al cliente autenticado por el token.

En la lista se incluirán todos los Objetivos (publicados y en borrador).

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Respuesta

Campo Descripción
id ID del Objetivo
title_es Título del Objetivo en castellano
title_eu Título del Objetivo en euskera
description_es Descripción del Objetivo en castellano
description_eu Descripción del Objetivo en euskera
position Posición del Objetivo en la lista de objetivos del plan de mandato
draft Borrador sí/no. Si el Objetivo está en borrador el valor es true, si está publicado el valor es false
GET
/api/v1/goals

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/goals -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de respuesta

{ "goals":
  [
    {
      "id": 1,
      "title_es": "Mejora del Casco Antiguo",
      "title_eu": "Mejora del Casco Antiguo E",
      "description_es": "Sed viverra eros in facilisis feugiat. Donec et luctus tellus aliquet.",
      "description_eu": "Nam eros purus, tincidunt sit amet molestie nec",
      "position": 1,
      "draft": false
    },
    {
      "id": 2,
      "title_es": "Mejora de la seguridad vial urbana",
      "title_eu": "Mejora de la seguridad vial urbana E",
      "description_es": "Sed viverra eros in facilisis feugiat. Donec et luctus tellus aliquet.",
      "description_eu": "Nam eros purus, tincidunt sit amet molestie nec",
      "position": 2,
      "draft": false
    }
  ]
}

Obtener Objetivo

Obtener los datos de un Objetivo concreto.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID del Objetivo

Respuesta

Campo Descripción
id ID del nuevo Objetivo
title_es Título del nuevo Objetivo
title_eu Título del nuevo Objetivo
description_es Descripción del nuevo Objetivo
description_eu Descripción del nuevo Objetivo
position Posición del Objetivo en la lista de objetivos del plan de mandato
draft true si está en borrador, false si está publicado
inserted_at Fecha y hora de creación inicial en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de la actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
GET
/api/v1/goals/{id}

Ejemplo de petitición

curl -X GET https://kontuematea.irekia.euskadi.eus/api/v1/goals/3 -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de respuesta

{
  "goal": {
    "id": 3,
    "title_es": "foo",
    "title_eu": "foo",
    "description_es": "bar",
    "description_eu": "bar",
    "position": 4,
    "draft": false,
    "inserted_at": "2007-03-05T14:30Z",
    "updated_at": "2007-04-05T14:30Z"
  }
}

Crear Objetivo

Crear nuevo Objetivo.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"
Content-Type application/json

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Datos a enviar

Campo Descripción
title_es Título del nuevo Objetivo
title_eu Título del nuevo Objetivo
description_es Descripción del nuevo Objetivo (HTML)
description_eu Descripción del nuevo Objetivo (HTML)
position Posición del objetivo en la lista de objtivos del plan de mandato
draft true si está en borrador, false si está publicado

Respuesta

Campo Descripción
id ID del nuevo Objetivo
title_es Título del nuevo Objetivo
title_eu Título del nuevo Objetivo
description_es Descripción del nuevo Objetivo
description_eu Descripción del nuevo Objetivo
position Posición del objetivo en la lista de objtivos del plan de mandato
draft true si está en borrador, false si está publicado
inserted_at Fecha y hora en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
POST
/api/v1/goals

Ejemplo de petición

curl -X POST https://kontuematea.irekia.euskadi.eus/api/v1/goals -d @data.json  -H "Content-Type: application/json" -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de data.json

{"goal": {
    "title_es":"foo",
    "title_eu":"foo",
    "description_es":"bar",
    "description_eu":"bar",
    "position":10,
    "draft":true
  }
}

Ejemplo de respuesta

{"goal": {
  "id": 3,
  "title_es": "foo",
  "title_eu": "foo",
  "description_es": "bar",
  "description_eu": "bar",
  "position": 10,
  "draft": true,
  "inserted_at": "2020-04-05T14:30Z",
  "updated_at": "2020-04-05T14:30Z"
}

Actualizar Obetivo

Actualizar los datos de un Objetivo.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID del Objetivo a actualizar

Datos a enviar

Campo Descripción
title_es Título del nuevo Objetivo
title_eu Título del nuevo Objetivo
description_es Descripción del nuevo Objetivo
description_eu Descripción del nuevo Objetivo
draft true si está en borrador, false si está publicado

Respuesta

Campo Descripción
id ID del nuevo Objetivo
title_es Título del nuevo Objetivo
title_eu Título del nuevo Objetivo
description_es Descripción del nuevo Objetivo
description_eu Descripción del nuevo Objetivo
draft true si está en borrador, false si está publicado
inserted_at Fecha y hora de creación inicial en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de la actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
PATCH
/api/v1/goals/{id}

Ejemplo de petitición

curl -X PATCH https://kontuematea.irekia.euskadi.eus/api/v1/goals/3 -d @data.json  -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de data.json

{
  "title_es": "foo",
  "title_eu": "foo",
  "description_es": "bar",
  "description_eu": "bar",
  "draft": false
}

Ejemplo de respuesta

{
  "id": "3",
  "title_es": "foo",
  "title_eu": "foo",
  "description_es": "bar",
  "description_eu": "bar",
  "draft": false,
  "inserted_at": "2007-03-05T14:30Z",
  "updated_at": "2007-04-05T14:30Z",
}

Eliminar objetivo

Sólo se podrán eliminar Objetivos que no tienen asignada ninguna Acción.

Si el Objetivo tiene asignada alguna Acción, se devolverá un código de respuesta HTTP 403 Forbidden.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID del Objetivo a eliminar

Respuesta

Codigo de estado HTTP 204 No Content.

DELETE
/api/v1/goals/{id}

Ejemplo de petición

curl -X DELETE https://kontuematea.irekia.euskadi.eus/api/v1/goals/3 -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Acciones

Cada Objetivo contiene varias Acciones.

Cada Acción se caracretiza con los siguientes datos:

  • ID Objetivo - goal_id
  • Título de la Acción (en castellano y en euskera) - title_es, title_eu
  • Descripción de la acción (en castellano y en euskera) - description_es, description_eu
  • Fecha inicio prevista - starts_on_expected
  • Fecha inicio real (opcional) - starts_on
  • Fecha fin prevista (opcional) - ends_on_expected
  • Fecha fin real (opcional) - ends_on
  • Presupuesto (opcional) - budget
  • Lista de temáticas - topics
  • Lista de ámbitos geográficos (opcional) - subdivisions
  • Lista de ODS (opcional) - ods
  • Lista de indicadores - indicators
  • Posición en el listado de acciones para el objetivo al que pertenece - position

Además cada Acción puede estar en borrador o publicada.

Las Acciones en borrador no salen en la parte pública de la web. Se pueden consultar sólo desde el Área de gestión.

Las Acciones publicadas pueden estar desestimadas. En este caso sí salen en la parte pública de la web pero no se pueden añadir más actividades a la acción.

Lista de acciones

La petición permite obtener la lista de todas las Acciones del plan del mandato junto con sus Indicadores, Temáticas, Ámbitos geográficos, ODS y el Objetivo al que corresponden.

En la lista se incluirán todas las Acciones (publicacadas y en borrador).

Cabecera de la petición

Parámetro Descripción
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Respuesta

Campo Descripción
id ID de la Acción
goal Datos del Objetivo al que corresponde la acción (ID y título en castellano y euskera)
title_es Título de la Acción en castellano
title_eu Título de la Acción en euskera
description_es Descripción de la Acción en castellano
description_eu Descripción de la Acción en euskera
starts_on_expected Fecha inicio prevista en formato ISO 8601 (YYYY-MM-DD)
starts_on Fecha inicio real en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha inicio real
ends_on_expected Fecha fin prevista en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha fin
ends_on Fecha fin real en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha fin
budget Presupuesto en euros o null si no hay presupuesto asignado
draft Borrador sí/no. Si la Acción está en borrador el valor es true, si está publicada el valor es false
discarded Desestimada sí/no. Si la Acción está desestimada el valor es true, si no está desestimada, el valor es false
position Número entero que indica la posición de la Acción en la lista de acciones del objetivo al que pertenece.
topics Lista de las temáticas asignadas a la Acción. Contiene los datos completos de cada temática (ID y título en castellano y euskera)
subdivisions Lista de los ámbitos geográficos asignados a la Acción. Contiene el ID y el nombre de cada ámbito en castellano y euskera)
ods Lista de los objetivos de desarrollo sostenible (ODS) asignados a la Acción. Contiene el ID y el título de cada ODS en castellano y euskera)
indicators Lista de los indicadores asociados con la Acción. Contiene los datos compeltos de cada indicador (ID, modalidad, título en castellano y euskera, denomninación en castellano y euskera, valor actual, valor objetivo)
inserted_at Fecha y hora de creación inicial en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de la actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
GET
/api/v1/acts

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/acts -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de respuesta

{"acts": 
  [
    {
      "id": "1",
      "goal": {
        "id": 10,
        "title_es": "Mejorar el empleo",
        "title_eu": "Lana obetu"
      },
      "title_es": "Planes de Empleo y programas de formación y capacitación",
      "title_eu": "Planes de Empleo y programas de formación y capacitación",
      "description_es": "Se van a desarrollar planes de empleo y otros programas experienciales en colaboración con diferentes agentes dirigidos a facilitar oportunidades de empleo directo a personas desempleadas",
      "description_eu": "Se van a desarrollar planes de empleo y otros programas experienciales en colaboración con diferentes agentes dirigidos a facilitar oportunidades de empleo directo a personas desempleadas",
      "starts_on_expected": "2018-01-01",
      "starts_on": "2018-01-10",
      "ends_on_expected": null,
      "ends_on": null,
      "budget": 125000,
      "draft": false,
      "discarded": false,
      "position": 1,
      "topics":[
        {
          "id": 6,
          "title_es": "Empleo y talento",
          "title_eu": "Enplegua eta talentua"
        },
        {
          "id": 15,
          "title_es": "Igualdad",
          "title_eu": "Berdintasuna"
        }
      ],
      "subdivisions":[
        {
          "id": 2,
          "name_es": "Casco Viejo",
          "name_eu": "Casco Viejo (eu)"
        },
        {
          "id": 3,
          "name_es": "Barrio Alto",
          "name_eu": "Barrio Alto (eu)"
        }
      ],
      "ods": [
       {
         "id": 1,
         "title_es": "Poner fin a la pobreza en todas sus formas y en todo el mundo",
         "title_eu": "Pobrezia mota guztiak desagertzea mundu osoan."
       },
       {
         "id": 2,
         "title_es": "Poner fin al hambre, lograr la seguridad alimentaria y la mejora de la nutrición y promover la agricultura sostenible",
         "title_eu": "Gosea amaitzea, elikagai-segurtasun eta elikadura hobea lortzea, eta nekazaritza jasangarria bultzatzea."
       }
      ],
      "indicators": [
        {
          "id": 1,
          "title_es": "Primer indicador",
          "title_eu": "Primer indicador E",
          "type": "numeric",
          "goal_value": 20000.0,
          "current_value_es": 5000.0,
          "current_value_eu": 5000.0,
          "units_es": "personas",
          "units_eu": "personas E",
        },
        {
          "id": 2,
          "title_es": "Indicador en porcentaje",
          "title_eu": "Indicador en porcentaje E",
          "type": "percentage",
          "goal_value": null,
          "current_value_es": 30.0,
          "current_value_eu": 30.0,
          "units_es": "%",
          "units_eu": "%"
        },
        {
          "id": 3,
          "title_es": "Indicador por fases",
          "title_eu": "Indicador por fases E",
          "type": "phases",
          "goal_value": null,
          "current_value_es": "En proceso",
          "current_value_eu": "En proceso E",
          "units_es": "",
          "units_eu": ""
        }
      ]
    },
    {
      "id": "2",
      "goal": {
        "id": 15,
        "title_es": "Transformación urbana",
        "title_eu": "Hiri transformazioa"
      },
      "title_es": "Implementación del Plan de Terrazas de Hostelería",
      "title_eu": "Implementación del Plan de Terrazas de Hostelería E",
      "description_es": "El Plan estará orientado a inspeccionar que el uso actual del espacio público se ajuste a lo autorizado en base a la ordenanza municipal actual, es decir, a reforzar el cumplimiento de los permisos actuales y para que cada establecimiento no ocupe más de lo que debe.",
      "description_eu": "El Plan estará orientado a inspeccionar que el uso actual del espacio público se ajuste a lo autorizado en base a la ordenanza municipal actual, es decir, a reforzar el cumplimiento de los permisos actuales y para que cada establecimiento no ocupe más de lo que debe. E",
      "starts_on": "2020-03-01",
      "end_on": "2023-03-31",
      "budget": 125000,
      "draft": false,
      "discarded": false,
      "position": 2,
      "topics":[
        {
          "id": 2,
          "title_es": "Comercio local",
          "title_eu": "Tokiko merkataritza"
        },
        {
          "id": 12,
          "title_es": "Empleo y talento",
          "title_eu": "Enplegua eta talentua"
        },
        {
          "id": 15,
          "title_es": "Consumo",
          "title_eu": "Kontsumoa"
        }
      ],
      "indicators": [
        {
          "id": 4,
          "title_es": "Indicador con cuatro fases",
          "title_eu": "Indicador con cuatro fases E",
          "type": "phases",
          "goal_value": null,
          "current_value_es": "Elaboración de proyecto y pliegos de contratación",
          "current_value_eu": "Elaboración de proyecto y pliegos de contratación E",
          "units_es": "",
          "units_eu": ""
        }
      ]
    }
  ]
}

Crear acción

Crear nueva Acción asociada a un Objetivo.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"
Content-Type application/json

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Datos a enviar

Campo Descripción
goal_id ID del Objetivo al que corresponde la acción
title_es Título de la Acción en castellano
title_eu Título de la Acción en euskera
description_es Descripción de la Acción en castellano
description_eu Descripción de la Acción en euskera
starts_on_expected Fecha inicio prevista en formato ISO 8601 (YYYY-MM-DD)
starts_on Fecha inicio real en formato ISO 8601 (YYYY-MM-DD) (opcional)
ends_on_expected Fecha fin prevista en formato ISO 8601 (YYYY-MM-DD) (opcional)
ends_on Fecha fin real en formato ISO 8601 (YYYY-MM-DD) (opcional)
budget Presupuesto en euros (opcional)
topics_ids Lista de los IDs de las temáticas asignadas a la Acción
ods_ids Lista de los IDs de los Objetivos de Desarrollo Sostenible (ODS) asignados a la Acción
subdivisions_ids Lista de los IDs de los ámbitos geográficos asignados a la Acción
draft true si está en borrador, false si está publicada

Respuesta

Campo Descripción
id ID de la nueva Acción
goal Datos del Objetivo al que corresponde la acción (ID y título en castellano y euskera)
title_es Título de la Acción en castellano
title_eu Título de la Acción en euskera
description_es Descripción de la Acción en castellano
description_eu Descripción de la Acción en euskera
starts_on_expected Fecha inicio prevista en formato ISO 8601 (YYYY-MM-DD)
starts_on Fecha inicio real en formato ISO 8601 (YYYY-MM-DD)
ends_on_expected Fecha fin prevista en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha fin
ends_on Fecha fin real en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha fin
budget Presupuesto en euros o null si no hay presupuesto asignado
draft true si está en borrador, false si está publicada
topics Lista de las temáticas asignadas a la Acción. Contiene los datos completos de cada temática (ID y título en castellano y euskera)
ods Lista de los Objetivos de Desarrollo Sostenible (ODS) asignados a la Acción. Contiene los datos completos de cada ODS (ID y nombre en castellano y euskera)
subdivisions Lista de los ámbitos geográficos asignados a la Acción. Contiene los datos completos de cada ámbito (ID, nombre y descripción en castellano y euskera)
indicators Lista vacía ya que todavía no se han creado los indicadores.
inserted_at Fecha y hora en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
POST
/api/v1/acts

Ejemplo de petición

curl -X POST https://kontuematea.irekia.euskadi.eus/api/v1/acts -d @data.json -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de data.json

{"act":
  {
    "goal_id": 15,
    "title_es": "Incentivar el uso de la bicicleta en la ciudad",
    "title_eu": "Bizikletaren erabilera sustatu hirian",
    "description_es": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas.",
    "description_eu": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas. E",
    "starts_on_expected": "2020-03-01",
    "starts_on": "2020-04-15",
    "end_on_expected": "2023-03-31",
    "end_on": null,
    "budget": 125000,
    "draft": true,
    "topics_ids":[2,6,15]
  }
}

Ejemplo de respuesta

{"act": {
  "id": "30",
  "goal": {
    "id": 15,
    "title_es": "Transformación urbana",
    "title_eu": "Hiri transformazioa"
  },
  "title_es": "Incentivar el uso de la bicicleta en la ciudad",
  "title_eu": "Bizikletaren erabilera sustatu hirian",
  "description_es": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas.",
  "description_eu": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas. E",
  "starts_on_expected": "2020-03-01",
  "starts_on": "2020-04-15",
  "end_on_expected": "2023-03-31",
  "end_on": null,
  "budget": 125000,
  "draft": true,
  "topics":[
    {
      "id": 2,
      "title_es": "Comercio local",
      "title_eu": "Tokiko merkataritza"
    },
    {
      "id": 6,
      "title_es": "Empleo y talento",
      "title_eu": "Enplegua eta talentua"
    },
    {
      "id": 15,
      "title_es": "Consumo",
      "title_eu": "Kontsumoa"
    }
  ],
  "ods": [],
  "subdivisions": [],
  "indicators": [],
  "inserted_at": "2020-04-05T14:30Z",
  "updated_at": "2020-04-05T14:30Z"
 }

Obtener acción

Obtener los datos completos de una Acción incluido el Objetivo al que pertence y Temáticas, Ámbitos geográficos, ODS e Indicadores asociados.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID de la Acción

Respuesta

Campo Descripción
id ID de la Acción
goal Datos del Objetivo al que corresponde la Acción (ID y título en castellano y euskera)
title_es Título de la Acción en castellano
title_eu Título de la Acción en euskera
description_es Descripción de la Acción en castellano
description_eu Descripción de la Acción en euskera
starts_on_expected fecha inicio prevista en formato ISO 8601 (YYYY-MM-DD)
starts_on Fecha inicio real en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha inicio real
ends_on_expected fecha fin prevista en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha fin
ends_on Fecha fin real en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha fin
budget Presupuesto en euros o null si no hay presupuesto asignado
draft true si está en borrador, false si está publicada
topics Lista de las temáticas asignadas a la Acción. Contiene los datos completos de cada temática (ID y título en castellano y euskera)
ods Lista de los Objetivos de Desarrollo Sostenible (ODS) asignados a la Acción. Contiene los datos completos de cada ODS (ID y nombre en castellano y euskera)
subdivisions Lista de los ámbitos geográficos asignados a la Acción. Contiene los datos completos de cada ámbito (ID, nombre y descripción en castellano y euskera)
indicators Lista de los indicadores asociados con la Acción. Contiene los datos compeltos de cada indicador (ID, modalidad, título en castellano y euskera, denomninación en castellano y euskera, valor actual, valor objetivo)
inserted_at Fecha y hora de creación en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
GET
/api/v1/acts/{id}

Ejemplo de petición

curl -X GET https://kontuematea.irekia.euskadi.eus/api/v1/acts/23 -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de respuesta

{
  "act": {
    "id": "23",
    "goal": {
      "id": 15,
      "title_es": "Transformación urbana",
      "title_eu": "Hiri transformazioa"
    },
    "title_es": "Incentivar el uso de la bicicleta en la ciudad",
    "title_eu": "Incentivar el uso de la bicicleta en la ciudad E",
    "description_es": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas.",
    "descruption_eu": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas. E",
    "starts_on_expected": "2021-03-01",
    "starts_on": null,
    "end_on_expected": "2023-03-31",
    "end_on": null,
    "budget": 125000,
    "draft": false,
    "topics":[
      {
        "id": 2,
        "title_es": "Comercio local",
        "title_eu": "Tokiko merkataritza"
      },
      {
        "id": 15,
        "title_es": "Consumo",
        "title_eu": "Kontsumoa"
      }
    ],
    "indicators": [
      {
        "id": 25,
        "title_es": "Número de bicicletas de alquiler",
        "title_eu": "Alokatzeko bizikleta kopurua",
        "type": "numeric",
        "current_value_es": 30,
        "current_value_eu": 30,
        "units_es": "bicicletas",
        "units_eu": "bizikletak"
      }
    ],
    "subdivisions": [
      {
        "id":3,
        "name_es":"Ensanche",
        "name_eu":"Hirigintza-zabalgunea"
      }
    ],
    "ods": [
      {
        "id":9,
        "title_es":"Construir infraestructuras resilientes, promover la industrialización inclusiva y sostenible y fomentar la innovación",
        "title_eu":"Azpiegitura erresilienteak eraikitzea, industrializazio inklusiboa eta jasangarria bultzatzea, eta berrikuntza sustatzea."
      },
      {
        "id":11,
        "title_es":"Lograr que las ciudades y los asentamientos humanos sean inclusivos, seguros, resilientes y sostenibles",
        "title_eu":"Hiriak eta giza kokaguneak inklusiboak, seguruak, erresilienteak eta jasangarriak izatea lortzea."
      }
    ],
    "inserted_at": "2020-04-03T14:30Z",
    "updated_at": "2020-04-05T14:30Z"
  }
}

Actualizar acción

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"
Content-Type application/json

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID de la Acción a actualizar

Datos a enviar

Campo Descripción
goal_id ID del Objetivo al que corresponde la acción
title_es Título de la Acción en castellano
title_eu Título de la Acción en euskera
description_es Descripción de la Acción en castellano
description_eu Descripción de la Acción en euskera
starts_on_expected fecha inicio prevista en formato ISO 8601 (YYYY-MM-DD)
starts_on Fecha inicio real en formato ISO 8601 (YYYY-MM-DD) (opcional)
ends_on_expected fecha fin prevista en formato ISO 8601 (YYYY-MM-DD) (opcional)
ends_on Fecha fin real en formato ISO 8601 (YYYY-MM-DD) (opcional)
budget Presupuesto en euros (opcional)
draft true si está en borrador, false si está publicada
topics_ids Lista de los IDs de las temáticas a asignar a la Acción
ods_ids Lista de los IDs de los ODS a asignar a la Acción
subdivisions_ids Lista de los IDs de los ámbitos geográficos a asignar a la Acción

Respuesta

Campo Descripción
id ID de la Acción actualizada
goal Datos del Objetivo al que corresponde la acción (ID y título en castellano y euskera)
title_es Título de la Acción en castellano
title_eu Título de la Acción en euskera
description_es Descripción de la Acción en castellano
description_eu Descripción de la Acción en euskera
starts_on_expected fecha inicio prevista en formato ISO 8601 (YYYY-MM-DD)
starts_on Fecha inicio real en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha inicio real
ends_on_expected fecha fin prevista en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha fin
ends_on Fecha fin real en formato ISO 8601 (YYYY-MM-DD) o null si no existe fecha fin
budget Presupuesto en euros o null si no hay presupuesto asignado
draft true si está en borrador, false si está publicada
topics Lista de las temáticas asignadas a la Acción. Contiene los datos completos de cada temática (ID y título en castellano y euskera)
ods Lista de los Objetivos de Desarrollo Sostenible (ODS) asignados a la Acción. Contiene los datos completos de cada ODS (ID y nombre en castellano y euskera)
subdivisions Lista de los ámbitos geográficos asignados a la Acción. Contiene el ID y el nombre de cada ámbito en castellano y euskera)
indicators Lista de los indicadores asociados con la Acción. Contiene los datos compeltos de cada indicador (ID, modalidad, título en castellano y euskera, denomninación en castellano y euskera, valor actual, valor objetivo)
inserted_at Fecha y hora de creación en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
PATCH
/api/v1/acts/{id}

Ejemplo de petición

curl -X PATCH https://kontuematea.irekia.euskadi.eus/api/v1/acts/23 -d @data.json -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de data.json

{
  "goal_id": 15,
  "title_es": "Incentivar el uso de la bicicleta en la ciudad",
  "title_eu": "Incentivar el uso de la bicicleta en la ciudad E",
  "description_es": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas.",
  "description_eu": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas. E",
  "starts_on_expected": "2021-03-01",
  "starts_on": null,
  "end_on_expected": "2023-03-31",
  "end_on": null,
  "budget": 125000,
  "draft": "false",
  "topics_ids":[2,15],
  "ods_ids":[9,11],
  "subdivisions_ids":[3]
}

Ejemplo de respuesta

{"act": {
  "id": "23",
  "goal": {
    "id": 15,
    "title_es": "Transformación urbana",
    "title_eu": "Hiri transformazioa"
  },
  "title_es": "Incentivar el uso de la bicicleta en la ciudad",
  "title_eu": "Incentivar el uso de la bicicleta en la ciudad E",
  "description_es": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas.",
  "description_eu": "Creación de nuevos aparcamientos para bicicletas en origen y destino, la ampliación de la red de infraestructuras, campañas de sensibilización sobre los beneficios del uso de la bicicleta, la puesta en marcha de un proyecto de ciclologística y la creación de una red de aparcamientos seguros de bicicletas. E",
  "starts_on_expected": "2021-03-01",
  "starts_on": null,
  "end_on_expected": "2023-03-31",
  "end_on": null,
  "budget": 125000,
  "draft": false,
  "topics":[
    {
      "id": 2,
      "title_es": "Comercio local",
      "title_eu": "Tokiko merkataritza"
    },
    {
      "id": 15,
      "title_es": "Consumo",
      "title_eu": "Kontsumoa"
    }
  ],
  "ods":[
    {
      "id":9,
      "title_es":"Construir infraestructuras resilientes, promover la industrialización inclusiva y sostenible y fomentar la innovación",
      "title_eu":"Azpiegitura erresilienteak eraikitzea, industrializazio inklusiboa eta jasangarria bultzatzea, eta berrikuntza sustatzea."
    },
    {
      "id":11,
      "title_es":"Lograr que las ciudades y los asentamientos humanos sean inclusivos, seguros, resilientes y sostenibles",
      "title_eu":"Hiriak eta giza kokaguneak inklusiboak, seguruak, erresilienteak eta jasangarriak izatea lortzea."
    }
  ],
  "subdivisions":[
    {
      "id":3,
      "name_es":"Ensanche","name_eu":"Hirigintza-zabalgunea"
    }
  ]
  "indicators": [
    {
      "id": 25,
      "title_es": "Número de bicicletas de alquiler",
      "title_eu": "Número de bicicletas de alquiler E",
      "type": "numeric",
      "current_value_es": 30,
      "current_value_eu": 30,
      "units_es": "bicicletas",
      "units_eu": "bizikletak"
    }
  ],
  "inserted_at": "2020-04-03T14:30Z",
  "updated_at": "2020-04-05T14:30Z"
}

Eliminar acción

Eliminar una Acción.

Sólo se podrán eliminar Acciones que no tienen asignada ninguna Actividad ni Indicador.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID de la Acción a eliminar

Respuesta

Codigo de estado HTTP 204 No Content.

DELETE
/api/v1/acts/{id}

Ejemplo de petición

curl -X DELETE https://kontuematea.irekia.euskadi.eus/api/v1/acts/3 -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Indicadores

Una Acción debe tener asignados uno o varios Indicadores. Cada Indicador pertenece a alguno de los Tipos de indicadores disponibles en la aplicación.

El Tipo de indicador define la modalidad del valor del indicador (numérico, porcentaje o por fases) y, en el caso de indicadores por fases, las opciones para las fases. Para más información sobre los tipos de indicadores, ver el apartado Tipos de indicadores.

Cada Indicador se caracteriza con los siguientes datos:

  • ID actividad - act_id
  • ID tipo indicador - kind_id
  • Título del indicador (en castellano y en euskera) - title_es, title_eu
  • Denominación (en castellano y en euskera, opcional) - units_es, units_eu
  • Valor objetivo (sólo para los indicadores de tipo numérico, opcional) - goal_value
  • Valor actual (en castellano y en euskera) - current_value_es, current_value_eu

El valor actual del Indicador se actualiza a través de las activiades relacionadas con la Acción que le corresponde.

Lista de indicadores

La petición permite obtener la lista de Indicadores que corresponden a una Acción.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
act_id ID de la Acción

Respuesta

Campo Descripción
id ID del Indicador
act ID y título en castellano y euskera de la acción que corresponde al Indicador
indicator_kind ID y modalidad del Tipo del indicador que corresponde al Indicador
title_es Título del Indicador en castellano
title_eu Título del Indicador en euskera
goal_value valor objetivo para el Indicador
current_value_es Valor actual del Indicador en castellano
current_value_eu Valor actual del Indicador en euskera
units_es Denominación del valor del Indicador en castellano
units_eu Denominación del valor del Indicador en euskera
inserted_at Fecha y hora de creación en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de la última actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
GET
/api/v1/acts/{act_id}/indicators

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/acts/1/indicators -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de respuesta

{"indicators":
  [
    {
      "id":4,
      "act": {
        "id":5,
        "title_es":"Reurbanización de la calle Mayor ",
        "title_eu":"Kale Nagusiaren berrurbanizazioa"
      },
      "indicator_kind": {
        "id":5,
        "type":"phases"
      },
      "current_value_es":"Fase de licitación pública",
      "current_value_eu":"Lizitazioa",
      "goal_value":null,
      "title_es":"Calle Mayor ",
      "title_eu":"Kale Nagusia",
      "units_es":null,
      "units_eu":null,
      "inserted_at":"2020-03-05T11:34:52",
      "updated_at":"2020-04-20T08:03:26"
    },
    {
      "id":25,
      "act":{
        "id":5,
        "title_es":"Reurbanización de la calle Mayor ",
        "title_eu":"Kale Nagusiaren berrurbanizazioa"
      },
      "indicator_kind":{
        "id":1,
        "type":"percentage"
      },
      "current_value_es":0.0,
      "current_value_eu":0.0,
      "goal_value":null,
      "title_es":"% cumplimiento",
      "title_eu":"Betetze %",
      "units_es":"%",
      "units_eu":"%",
      "inserted_at":"2020-09-22T12:05:27",
      "updated_at":"2020-09-22T12:05:27"
    }
  ]
}

Crear indicador

Crear nuevo Indicador asociado a una Acción.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"
Content-Type application/json

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Datos a enviar

Campo Descripción
act_id ID de la Acción a la que corresponde el indicador
kind_id ID del Tipo de indicador. Para obtener el ID ver el apartado "Tipos de indicadores"
title_es Título del Indicador en castellano
title_eu Título del Indicador en euskera
goal_value valor objetivo del Indicador (sólo es necesario si el indicador es de la modalidad numeric, es opcional)
units_es Denominación del Indicador en castellano (opcional)
units_eu Denominación del Indicador en euskera (opcional)

Respuesta

Campo Descripción
id ID del nuevo Indicador
act Datos de la Acción a la que corresponde el indicador (ID y título en castellano y euskera)
indicator_kind Datos del Tipo de indicador (ID y modalidad)
title_es Título del Indicador en castellano
title_eu Título del Indicador en euskera
goal_value Valor objetivo del Indicador o null si no hay valor asignado
current_value_es Valor inicial del Indicador en castellano. En caso de indicadores de la modalidad phases, el valor incial será el nombre de la primera fase. Para indicadores de la modalidad percentage y numeric el valor inicial será 0
current_value_eu Valor inicial del Indicador en euskera. En caso de indicadores de la modalidad phases, el valor inicial será el nombre de la primera fase. Para indicadores de la modalidad percentage y numeric el valor inicial será 0
units_es Denominación del Indicador en castellano (puede ser un string vacío)
units_eu Denominación del Indicador en euskera (puede ser un string vacío)
inserted_at Fecha y hora en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
POST
/api/v1/indicators

Ejemplo de petición

curl -X POST https://kontuematea.irekia.euskadi.eus/api/v1/indicators -d @data.json -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de data.json

{
  "act_id": 30,
  "kind_id": 1,
  "title_es": "Longitud total de la red de bidegorri",
  "title_eu": "Bidegorri sarearen luzera",
}

Ejemplo de respuesta

{
  "indicator":{
    "id":28,
    "act":{
      "id":30,
      "title_es":"Incentivar el uso de la bicicleta en la ciudad",
      "title_eu":"Bizikletaren erabilera sustatu hirian"
    },
    "indicator_kind":{
      "id":1,
      "type":"percentage"
    },
    "current_value_es":0.0,
    "current_value_eu":0.0,
    "goal_value":null,
    "title_es":"Longitud total de la red de bidegorri",
    "title_eu":"Bidegorri sarearen luzera",
    "units_es":"%",
    "units_eu":"%",
    "inserted_at":"2020-09-22T15:11:26",
    "updated_at":"2020-09-22T15:11:26"
  }
}

Obtener indicador

Obtener todos los datos de un Indicador incluidos los datos de la Acción asociada y el Tipo de indicador.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID del Indicador

Respuesta

Campo Descripción
id ID del nuevo Indicador
act Datos de la Acción a la que corresponde el indicador (ID y título en castellano y euskera)
indicator_kind Datos del Tipo de indicador (ID y modalidad)
title_es Título del Indicador en castellano
title_eu Título del Indicador en euskera
goal_value Valor objetivo del Indicador o null si no hay valor asignado
current_value_es Valor inicial del Indicador en castellano. En caso de indicadores de la modalidad phases, el valor incial será el nombre de la primera fase. Para indicadores de la modalidad percentage y numeric el valro inicial será 0
current_value_eu Valor inicial del Indicador en euskera. En caso de indicadores de la modalidad phases, el valor inicial será el nombre de la primera fase. Para indicadores de la modalidad percentage y numeric el valor inicial será 0
units_es Denominación del Indicador en castellano (puede ser un string vacío)
units_eu Denominación del Indicador en euskera (puede ser un string vacío)
inserted_at Fecha y hora en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
GET
/api/v1/indicators/{id}

Ejemplo de petición

curl https://kontuematea.irekia.euskadi.eus/api/v1/indicators/28

Ejemplo de respuesta

{
  "indicator":{
    "id":28,
    "act":{
      "id":30,
      "title_es":"Incentivar el uso de la bicicleta en la ciudad",
      "title_eu":"Bizikletaren erabilera sustatu hirian"
    },
    "indicator_kind":{
      "id":1,
      "type":"percentage"
    },
    "current_value_es":0.0,
    "current_value_eu":0.0,
    "goal_value":null,
    "title_es":"Longitud total de la red de bidegorri",
    "title_eu":"Bidegorri sarearen luzera",
    "units_es":"%",
    "units_eu":"%",
    "inserted_at":"2020-09-22T15:11:26",
    "updated_at":"2020-09-22T15:11:26"
  }
}

Actuazlizar indicador

Esta petición actualiza los datos descriptivos del Indicador. Su valor actual (current_value) se actualiza a través de las Actividades.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"
Content-Type application/json

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID del Indicador a actualizar

Datos a enviar

Campo Descripción
act_id ID de la Acción a la que corresponde el indicador
kind_id ID del Tipo de indicador
title_es Título del Indicador en castellano
title_eu Título del Indicador en euskera
goal_value Valor objetivo del Indicador (sólo es necesario si el indicador es de la modalidad numeric, es opcional)
units_es Denominación del Indicador en castellano (opcional)
units_eu Denominación del Indicador en euskera (opcional)

Respuesta

Campo Descripción
id ID del Indicador actualizado
act Datos de la Acción a la que corresponde el indicador (ID y título en castellano y euskera)
indicator_kind Datos del Tipo de indicador (ID y modalidad)
title_es Título del Indicador en castellano
title_eu Título del Indicador en euskera
goal_value Valor objetivo del Indicador (sólo es necesario si el indicador es de la modalidad numeric, es opcional)
current_value_es Valor actual del Indicador en castellano. En caso de indicadores de la modalidad phases, el valor actual será el nombre de la fase actual. Para indicadores de la modalidad percentage y numeric será el valor numérico correspondiente.
current_value_eu Valor actual del Indicador en euskera. En caso de indicadores de la modalidad phases, el valor actual será el nombre de la fase actual. Para indicadores de la modalidad percentage y numeric será el valor numérico correspondiente.
units_es Denominación del Indicador en castellano (opcional)
units_eu Denominación del Indicador en euskera (opcional)
inserted_at Fecha y hora de creación en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
PATCH
/api/v1/indicators/{id}

Ejemplo de petición

curl -X PATCH https://kontuematea.irekia.euskadi.eus/api/v1/indicators/28 -d @data.json -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de data.json

{
  "act_id": 30,
  "kind_id": 2,
  "title_es": "Longitud total de la red de bidegorri y caminos de paseo",
  "title_eu": "Longitud total de la red de bidegorri y cambinos de paseo E",
  "goal_value": 50,
  "units_es": "km",
  "units_eu": "km",
}

Ejemplo de respuesta

{
  "indicator":{
    "id":28,
    "act":{
      "id":30,
      "title_es":"Incentivar el uso de la bicicleta en la ciudad",
      "title_eu":"Bizikletaren erabilera sustatu hirian"
    },
    "indicator_kind":{
      "id":2,
      "type":"numeric"
    },
    "current_value_es":0.0,
    "current_value_eu":0.0,
    "goal_value":50.0,
    "title_es": "Longitud total de la red de bidegorri y caminos de paseo",
    "title_eu": "Longitud total de la red de bidegorri y cambinos de paseo E",
    "units_es":"km",
    "units_eu":"km",
    "inserted_at":"2020-09-22T15:11:26",
    "updated_at":"2020-09-23T12:11:26"
  }
}

Eliminar indicador

Se eliminará el Indicador de la lista de indicadores de la Acción a la que corredponde y de todas las Actividades asociadas a esta Acción.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID del Indicador a eliminar

Respuesta

Codigo de estado HTTP 204 No Content.

DELETE
/api/v1/indicators/{id}

Ejemplo de petición

curl -X DELETE https://kontuematea.irekia.euskadi.eus/api/v1/indicators/3 -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Actividades

Cada Acción tiene asociadas una o varias Actividades. Para cada Actividad se proporcionan los valores actuales de los indicadores asociados con la misma Acción. Además con cada actividad de pueden adjuntar fotos y documentos.

Cada Actividad se caracteriza con los siguientes datos:

  • ID Acción - act_id
  • Título de la Actividad (en castellano y en euskera) - title_es, title_eu
  • Descripción (en castellano y en euskera) - desc_es, desc_eu
  • Fecha - date
  • Valores para los indicadores asociados con la misma Acción - activity_indicators
  • Fotos - photos
  • Documentos - documents

Actualmente desde el API no se pueden subir fotos ni documentos.

Lista de actividades

La petición permite obtener la lista de todas las Actividades realizadas relacionadas con una Acción.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
act_id ID de la Acción

Respuesta

Campo Descripción
id ID de la Actividad
act ID y título en castellano y euskera de la Acción relacionada
title_es Título de la Actividad en castellano
title_eu Título de la Actividad en euskera
description_es Descripción de la Actividad en castellano (texto en HTML)
description_eu Descripción de la Actividad en euskera (texto en HTML)
date Fecha en formato ISO 8601 (YYYY-MM-DD)
draft Borrador sí/no. Si la Actividad está en borrador el valor es true, si está publicada el valor es false
activity_indicators Lista con los Indicadores relacionados con la Actividad con su valor al realizar la actividad. Este valor será diferente del valor actual del indicador si la actividad no es la última realizada para la Acción correspondiente
inserted_at Fecha y hora de creación en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de la última actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
GET
/api/v1/acts/{act_id}/activities

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/acts/6/activities

Ejemplo de respuesta

{
  "activities":[
    {
      "id":11,
      "act":{
        "id":6,
        "title_es":"Instalar iluminación en pasos de peatones",
        "title_eu":"Oinezkoentzako pasabideetan argiztapena jartzea"
      },
      "title_es":"Instalación luminaria",
      "title_eu":"Argi-instalazioa",
      "description_es":"<p>La instalación de farolas requiere ... por fases</p>",
      "description_eu":"<p>Instalazioak...</p>",
      "date":"2020-04-30",
      "draft":false,
      "activity_indicators":[
        {
          "indicator":{
            "id":6,
            "title_es":"Instalación",
            "title_eu":"Instalazioa",
            "units_es":"%",
            "units_eu":"%"
          },
          "indicator_value_es":50.0,
          "indicator_value_eu":50.0
        },
        {
          "indicator":{
            "id":29,
            "title_es":"Distancia iluminada",
            "title_eu":"Distancia iluminada E",
            "units_es":"km",
            "units_eu":"km"
          },
          "indicator_value_es":10.0,
          "indicator_value_eu":10.0
        },
        {
          "indicator":{
            "id":30,
            "title_es":"Ejecución proyecto",
            "title_eu":"Ejecución proyecto E",
            "units_es":null,
            "units_eu":null
          },
          "indicator_value_es":"En proceso",
          "indicator_value_eu":"Prozesatzen"
        }
      ],
      "inserted_at":"2020-03-05T14:50:33",
      "updated_at":"2020-03-05T14:50:33"
    },
    {
      "id":12,
      "act":{
        "id":6,
        "title_es":"Instalar iluminación en pasos de peatones",
        "title_eu":"Oinezkoentzako pasabideetan argiztapena jartzea"
      },
      "title_es":"Contratado estudio",
      "title_eu":"Azterlana kontratatuta",
      "description_es":"<p>El estudio requirió ...</p>",
      "description_eu":"<p>Estudioak ...</p>",
      "date":"2020-04-06",
      "draft":false,
      "activity_indicators":[
        {
          "indicator":{
            "id":6,
            "title_es":"Instalación",
            "title_eu":"Instalazioa",
            "units_es":"%",
            "units_eu":"%"
          },
          "indicator_value_es":1.0,
          "indicator_value_eu":1.0
        },
        {
          "indicator":{
            "id":29,
            "title_es":"Distancia iluminada",
            "title_eu":"Distancia iluminada E",
            "units_es":"km",
            "units_eu":"km"
          },
          "indicator_value_es":0.0,
          "indicator_value_eu":0.0
        },
        {
          "indicator":{
            "id":30,
            "title_es":"Ejecución proyecto",
            "title_eu":"Ejecución proyecto E",
            "units_es":null,
            "units_eu":null
          },
          "indicator_value_es":"Sin iniciar",
          "indicator_value_eu":"Hasi gabe"
        }
      ],
      "inserted_at":"2020-03-05T14:52:44",
      "updated_at":"2020-03-05T14:52:44"
    }
  ]
}

Crear actividad

Crear una nueva Actividad asociada a una Acción. Junto con los datos de la Actividad hay que proporcinar los valores para los Indicadores que corresponden a la Acción asociada.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"
Content-Type application/json

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Datos a enviar

Campo Descripción
act_id ID de la Acción asociada
title_es Título de la Actividad en castellano
title_eu Título de la Actividad en euskera
description_es Descripción de la Actividad en castellano (texto HTML)
description_eu Descripción de la Actividad en euskera (texto HTML)
date Fecha en formato ISO 8601 (YYYY-MM-DD)
activity_indicators Lista con los valores de los indicadores que corresponden a la Acción asociada. Para cada indicador se indica su ID y el valor que corresponde a la Actividad nueva. En el caso de indicadores de la modalidad phases se proporciona el valor que corresponde a la fase tal y como se obtiene de la lista de tipos de indicadores. Para indicadores de las modalidades numeric y percentage se proporciona el valor numérico

Respuesta

Campo Descripción
id ID de la nueva Actividad
act ID y título en castellano y euskera de la Acción relacionada
title_es Título de la Actividad en castellano
title_eu Título de la Actividad en euskera
desc_es Descripción de la Actividad en castellano (texto HTML)
desc_eu Descripción de la Actividad en euskera (texto HTML)
date Fecha en formato ISO 8601 (YYYY-MM-DD)
activity_indicators Lista con los Indicadores relacionados con la Actividad nueva con su valor al realizar la actividad. Este valor será diferente del valor actual del Indicador si la Actividad no es la última realizada para la Acción correspondiente
inserted_at Fecha y hora en la que se ha creado la Actividad en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de actualización de la Actividad en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
POST
/api/v1/activities

Ejemplo de petición

curl -X POST https://kontuematea.irekia.euskadi.eus/api/v1/activities -d @data.json -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de data.json

{
  activity: {
    act_id: 6,
    title_es: "Instalación finalizada",
    title_eu: "Instalazioa amaituta",
    description_es: "<p><b>Finalizada</b> la instalación de las farolas</p>",
    description_eu: "<p>Argien instalazioa <b>amaituta</b></p>",
    date: "2020-09-20",
    draft: false,
    activity_indicators: [
      {
        "indicator_id":29,
        "indicator_value":20
      },
      {
        "indicator_id":30,
        "indicator_value":2
      },
      {
        "indicator_id":6,
        "indicator_value":100
      }
    ]
  }
}

Ejemplo de respuesta

{
  "activity":{
    "id":22,
    "act":{
      "id":6,
      "title_es":"Instalar iluminación en pasos de peatones",
      "title_eu":"Oinezkoentzako pasabideetan argiztapena jartzea"
    },
    "title_es":"Instalación finalizada",
    "title_eu":"Instalazioa amaituta",
    "description_es":"<p><b>Finalizada</b> la instalación de las farolas</p>",
    "description_eu":"<p>Argien instalazioa <b>amaituta</b></p>",
    "date":"2020-09-20",
    "draft":false,
    "activity_indicators":[
      {
        "indicator":{
          "id":6,
          "title_es":"Instalación",
          "title_eu":"Instalazioa",
          "units_es":"%",
          "units_eu":"%"
        },
        "indicator_value_es":100.0,
        "indicator_value_eu":100.0
      },
      {
        "indicator":{
          "id":29,
          "title_es":"Distancia iluminada",
          "title_eu":"Distancia iluminada E",
          "units_es":"km",
          "units_eu":"km"
        },
        "indicator_value_es":20.0,
        "indicator_value_eu":20.0
      },
      {
        "indicator":{
          "id":30,
          "title_es":"Ejecución proyecto",
          "title_eu":"Ejecución proyecto E",
          "units_es":null,
          "units_eu":null
        },
        "indicator_value_es":"Finalizada",
        "indicator_value_eu":"Amaituta"
      }
    ],
    "inserted_at":"2020-09-24T08:32:06",
    "updated_at":"2020-09-24T08:32:06"
  }
}

Obtener actividad

Obtener los datos de una Actividad incluidos los datos de la Acción que tiene asociada y los Indicadores que corresponden a esta Acción.

Los valores de los Indicadores corresponden al momento de realización de la Actividad.

Parámetros de la petición

Parámetro Descripción
id ID de la Actividad

Respuesta

Campo Descripción
id ID de la Actividad actualizada
act Datos de la Acción relacionada (ID y título en castellano y euskera)
title_es Título de la Actividad en castellano
title_eu Título de la Actividad en euskera
description_es Descripción de la Actividad en castellano
description_eu Descripción de la Actividad en euskera
date Fecha en formato ISO 8601 (YYYY-MM-DD)
draft Borrador sí/no. Si la Actividad está en borrador el valor es true, si está publicada el valor es false
activity_indicators Lista con los valores de los indicadores que corresponden a la Acción al realizar la Actividad
inserted_at Fecha y hora de creación en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
GET
/api/v1/activities/{id}

Ejemplo de petición

curl https://kontuematea.irekia.euskadi.eus/api/v1/activities/23

Ejemplo de respuesta

{
  "activity":{
    "id":23,
    "act":{
      "id":6,
      "title_es":"Instalar iluminación en pasos de peatones",
      "title_eu":"Oinezkoentzako pasabideetan argiztapena jartzea"
    },
    "title_es":"Instalación finalizada",
    "title_eu":"Instalazioa amaituta",
    "description_es":"<p><b>Finalizada</b> la instalación de las farolas</p>",
    "description_eu":"<p>Argien instalazioa <b>amaituta</b></p>",
    "date":"2020-09-20",
    "draft":false,
    "activity_indicators":[
      {
        "indicator":{
          "id":6,
          "title_es":"Instalación",
          "title_eu":"Instalazioa",
          "units_es":"%",
          "units_eu":"%"
        },
        "indicator_value_es":100.0,
        "indicator_value_eu":100.0
      },
      {
        "indicator":{
          "id":29,
          "title_es":"Distancia iluminada",
          "title_eu":"Distancia iluminada E",
          "units_es":"km",
          "units_eu":"km"
        },
        "indicator_value_es":20.0,
        "indicator_value_eu":20.0
      },
      {
        "indicator":{
          "id":30,
          "title_es":"Ejecución proyecto",
          "title_eu":"Ejecución proyecto E",
          "units_es":null,
          "units_eu":null
        },
        "indicator_value_es":"Finalizada",
        "indicator_value_eu":"Amaituta"
      }
    ],
    "inserted_at":"2020-09-24T09:16:47",
    "updated_at":"2020-09-24T09:16:47"
  }
}

Actualizar actividad

Actualizar los datos de una Actividad y los valores de los Indicadores relacionados.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"
Content-Type application/json

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID de la Actividad a actualizar

Datos a enviar

Campo Descripción
act_id ID de la Acción asociada
title_es Título de la Actividad en castellano
title_eu Título de la Actividad en euskera
description_es Descripción de la Actividad en castellano (texto HTML)
description_eu Descripción de la Actividad en euskera (texto HTML)
date Fecha en formato ISO 8601 (YYYY-MM-DD)
draft Borrador sí/no. Si la Actividad está en borrador el valor es true, si está publicada el valor es false
activity_indicators Lista con los valores de los indicadores que corresponden a la Acción asociada. Para cada indicador se indica su ID y el valor que corresponde a la Actividad nueva. En el caso de indicadores de la modalidad phases se proporciona el valor que corresponde a la fase tal y como se obtiene de la lista de tipos de indicadores. Para indicadores de las modalidades numeric y percentage se proporciona el valor numérico

Respuesta

Campo Descripción
id ID de la Actividad actualizada
act Datos de la Acción relacionada (ID y título en castellano y euskera)
title_es Título de la Actividad en castellano
title_eu Título de la Actividad en euskera
description_es Descripción de la Actividad en castellano
description_eu Descripción de la Actividad en euskera
date Fecha en formato ISO 8601 (YYYY-MM-DD)
draft Borrador sí/no. Si la Actividad está en borrador el valor es true, si está publicada el valor es false
activity_indicators Lista con los valores de los indicadores que corresponden a la Acción al realizar la Actividad
inserted_at Fecha y hora de creación en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
updated_at Fecha y hora de actualización en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
PATCH
/api/v1/activities/{id}

Ejemplo de petición

curl -X PATCH https://kontuematea.irekia.euskadi.eus/api/v1/activities/23 -d @data.json -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Ejemplo de data.json

{
  {
    activity: {
      act_id: 6,
      title_es: "Instalación entra en el últmo tramo",
      title_eu: "Instalación entra en el últmo tramo",
      description_es: "<p>Empieza el <b>último tramo</b> de la instalación de las farolas</p>",
      description_eu: "<p>Empieza el <b>último tramo</b> de la instalación de las farolas E</p>",
      date: "2020-09-20",
      draft: false,
      activity_indicators: [
        {
          "indicator_id":29,
          "indicator_value":15
        },
        {
          "indicator_id":30,
          "indicator_value":1
        },
        {
          "indicator_id":6,
          "indicator_value":75
        }
      ]
    }
  }
}

Ejemplo de respuesta

{
  "activity":{
    "id":23,
    "act":{
      "id":6,
      "title_es":"Instalar iluminación en pasos de peatones",
      "title_eu":"Oinezkoentzako pasabideetan argiztapena jartzea"
    },
    "title_es":"Instalación entra en el últmo tramo",
    "title_eu":"Instalación entra en el últmo tramo",
    "description_es":"<p>Empieza el <b>último tramo</b> de la instalación de las farolas</p>",
    "description_eu":"<p>Empieza el <b>último tramo</b> de la instalación de las farolas E</p>",
    "date":"2020-09-20",
    "draft":false,
    "activity_indicators":[
      {
        "indicator":{
          "id":6,
          "title_es":"Instalación",
          "title_eu":"Instalazioa",
          "units_es":"%",
          "units_eu":"%"
        },
        "indicator_value_es":75.0,
        "indicator_value_eu":75.0
      },
      {
        "indicator":{
          "id":29,
          "title_es":"Distancia iluminada",
          "title_eu":"Distancia iluminada E",
          "units_es":"km",
          "units_eu":"km"
        },
        "indicator_value_es":15.0,
        "indicator_value_eu":15.0
      },
      {
        "indicator":{
          "id":30,
          "title_es":"Ejecución proyecto",
          "title_eu":"Ejecución proyecto E",
          "units_es":null,
          "units_eu":null
        },
        "indicator_value_es":"En proceso",
        "indicator_value_eu":"Prozesatzen"
      }
    ],
    "inserted_at":"2020-09-24T09:16:47",
    "updated_at":"2020-09-24T10:01:40"
  }
}

Eliminar actividad

Se puede eliminar una Actividad siempre y cuando esta no tenga fotos ni documentos. Al elimnar una Actividad se actualizarán los valores de los Indicadores que corresponden a la Acción asociada con la Actividad.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Parámetros de la petición

Parámetro Descripción
id ID de la Actividad a eliminar

Respuesta

Código de estado HTTP 204 No Content.

DELETE
/api/v1/activities/{id}

Ejemplo de petición

curl -X DELETE https://kontuematea.irekia.euskadi.eus/api/v1/activities/23 -H "Authorization: Bearer eyJhbGciOiJIUzU..."

Temáticas

Las Temáticas se usan para clasificar las diferentes Acciones.

La lista de temáticas no se puede modificar a través del API. La única información disponible a través del API es la lista de temáticas.

Lista de temáticas

La petición permite obtener la lista de Temáticas.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Respuesta

Campo Descripción
id ID de la Temática
title_es Título de la Temática en castellano
title_eu Título de la Temática en euskera
GET
/api/v1/topics

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/topics

Ejemplo de respuesta

{ "topics":
  [
    {
      "id": "1",
      "title_es": "Acción social",
      "title_eu": "Gizarte-ekintza"
    },
    {
      "id": "2",
      "title_es": "Cooperación al desarrollo",
      "title_eu": "Garapenerako lankidetza"
    }
  ]
}

Ámbitos geográficos

Los Ámbitos geográficos se usan para clasificar las diferentes Acciones.

La lista de ámbitos geográficos se define desde la aplicación web. A través del API sólo se puede consultar la lista de ámbitos sin modificarla.

Lista de ámbitos geográficos

La petición permite obtener la lista actual de Ámbitos geográficos.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Respuesta

Campo Descripción
id ID del Ámbito geográfico
name_es Nombre del Ámbito geográfico en castellano
name_eu Nombre del Ámbito geográfico en euskera
description_es Descripción del Ámbito geográfico en castellano
description_eu Descripción del Ámbito geográfico en euskera
GET
/api/v1/subdivisions

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/subdivisions

Ejemplo de respuesta

{"subdivisions":
  [
    {
      "id":2,
      "name_es":"Casco Viejo",
      "name_eu":"Alde Zaharra",
      "description_es":"Casco antiguo de la localidad.",
      "description_eu":"Herriaren alde zaharrena."
    },
    {
      "id":3,
      "name_es":"Ensanche",
      "name_eu":"Hirigintza-zabalgunea",
      "description_es":"Ensanche urbanístico del s. XIX",
      "description_eu":"XIX. mendeko hirigintza-zabalgunea"
    }
  ]
}

Objetivos de Desarrollo Sostenible (ODS)

Cada una de las Acciones se puede clasificar en uno o varios ODS. La lista de ODS es fija y no se puede modificar.

Desde el API se puede acceder a la lista completa de ODS.

Lista de ODS

La petiticón permite obtener las lista de ODS.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Respuesta

Campo Descripción
id ID del ODS
title_es Título del ODS en castellano
title_eu Título del ODS en euskera
GET
/api/v1/ods

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/ods

Ejemplo de respuesta

{"ods":
  [
    {
      "id":1,
      "title_es":"Poner fin a la pobreza en todas sus formas y en todo el mundo",
      "title_eu":"Pobrezia mota guztiak desagertzea mundu osoan."
    },
    {
      "id":2,
      "title_es":"Poner fin al hambre, lograr la seguridad alimentaria y la mejora de la nutrición y promover la agricultura sostenible",
      "title_eu":"Gosea amaitzea, elikagai-segurtasun eta elikadura hobea lortzea, eta nekazaritza jasangarria bultzatzea."
    }
  ]
}

Tipos de indicadores

Los Tipos de indicadores se usan a la hora de crear un Indicador.

El Tipo de indicador define la modalidad del valor del Indicador (numérico, porcentaje o por fases) y, en el caso de indicadores por fases, las opciones para las fases.

Lista de tipos de indicadores

La petición permite obtener la lista de Tipos de indicadores.

Cabecera de la petición

Nombre Valor
Authorization "Bearer MI_TOKEN"

Donde MI_TOKEN es el token de la sesión obtenido como resultado de la autenticación del cliente.

Respuesta

Campo Descripción
id ID del tipo de indicador
type Modalidad - puede ser "numeric", "percentage" o "phases"
title_es Título del tipo de indicador en castellano
title_eu Título del tipo de indicador en euskera
options Lista con las opciones que corresponden al indicador. La lista incluye el título en castellano y euskera de la opción y el valor que le corresponde. Este valor debe usarse a la hora de crear una actividad que modifica el valor actual del indicador.La lista de opciones está disponible sólo para el caso de modalidad "phases"
GET
api/v1/indicator_kinds

Ejemplo de petición

$ curl https://kontuematea.irekia.euskadi.eus/api/v1/indicator_kinds

Ejemplo de respuesta

{
  "indicator_kinds":[
    {
      "id":1,
      "name_es":"Porcentaje",
      "name_eu":"Ehunekoa",
      "options":[]
    },
    {
      "id":2,
      "name_es":"Numérico",
      "name_eu":"Zenbakizkoa",
      "options":[]
    },
    {
      "id":3,
      "name_es":"Sin iniciar / En proceso / Finalizada",
      "name_eu":"Hasi gabe / Prozesatzen / Amaituta",
      "options":[
        {
          "name_es":"Sin iniciar",
          "name_eu":"Hasi gabe",
          "value":0
        },
        {
          "name_es":"En proceso",
          "name_eu":"Prozesatzen",
          "value":1
        },
        {
          "name_es":"Finalizada",
          "name_eu":"Amaituta",
          "value":2
        }
      ]
    },
    {
      "id":4,
      "name_es":"Borrador / Consulta e información / Aprobación",
      "name_eu":"Zirriborroa / Kontsulta eta informazioa / Onartzear",
      "options":[
        {
          "name_es":"Borrador",
          "name_eu":"Zirriborroa",
          "value":0
        },
        {
          "name_es":"Consulta e información",
          "name_eu":"Kontsulta eta informazioa",
          "value":1
        },
        {
          "name_es":"Aprobación",
          "name_eu":"Onartzea",
          "value":2
        }
      ]
    },
    {
      "id":5,
      "name_es":"Proyecto y pliegos / Licitación / Ejecución / Finalizada",
      "name_eu":"Proiektua eta pleguak / Lizitazioa / Exekuzioa / Amaitua",
      "options":[
        {
          "name_es":"Elaboración de proyecto y pliegos de contratación",
          "name_eu":"Proiektua eta pleguak",
          "value":0
        },
        {
          "name_es":"Fase de licitación pública",
          "name_eu":"Lizitazioa",
          "value":1
        },
        {
          "name_es":"Proyecto adjudicado y en ejecución",
          "name_eu":"Exekuzioa",
          "value":2
        },
        {
          "name_es":"Actuación finalizada",
          "name_eu":"Amaitua",
          "value":3
        }
      ]
    }
  ]
}
Ejemplos:
API OGP Euskadi Documentación