API

Esta sección documenta a API de CKAN, para desenvolvedores que desexan escribir código que interactúe cos sitios de CKAN e os seus datos.

A API Action de CKAN é unha poderosa API de estilo RPC que expón todas as características principais de CKAN aos clientes API. Toda a funcionalidade principal dun sitio web de CKAN (todo o que pode facer coa interface web e máis) pode ser utilizada por un código externo que chame á API de CKAN. Por exemplo, usando a API CKAN, a súa aplicación pode:

• Obter listas con formato JSON dos conxuntos de datos dun sitio, organizacións, grupos ou outros obxectos CKAN:
  • http://datos.satiagocompostela.gal/catalogo/api/3/action/package_list
  • http://datos.satiagocompostela.gal/catalogo/api/3/action/organization_list
  • http://datos.satiagocompostela.gal/catalogo/api/3/action/group_list
  • http://datos.satiagocompostela.gal/catalogo/api/3/action/tag_list
• Obter unha representación JSON completa dun conxunto de datos, un recurso ou ootro obxecto:
  • http://datos.satiagodecompostela.gal/catalogo/api/3/action/package_show?id=relacion-de-postos-de-traballo-rpt-2016
  • http://datos.satiagodecompostela.gal/catalogo/api/3/action/tag_show?id=dir3
  • http://datos.satiagodecompostela.gal/catalogo/api/3/action/organization_show?id=concello-de-santiago-de-compostela
• Buscar paquetes ou recursos que coincidan cunha consulta:
  • http://datos.satiagodecompostela.gal/catalogo/api/3/action/package_search?q=compostela
  • http://datos.satiagodecompostela.gal/catalogo/api/3/action/resource_search?query=name:face
• Crear, actualizar e eliminar conxuntos de datos, recursos e outros objetos
• Obter un fluxo de actividade de conxuntos de datos recentemente modificados nun sitio:
  • http://datos.satiagocompostela.gal/catalogo/api/3/action/recently_changed_packages_activity_list

Para obter a información detallada do API de CKAN pode acceder á URL: https://docs.ckan.org/en/2.8/api/