Quickstart
En esta guía aprenderás los conceptos básicos de los APIs y descubrirás cómo pueden ser utilizados para acceder a datos y funcionalidades de manera programática. Explora esta sección para entender cómo el API de Sicultura te permite interactuar con los datos culturales de forma automatizada y personalizada, abriendo un mundo de posibilidades para el desarrollo de aplicaciones y la integración de sistemas.
Un API (Application Programming Interface) es un conjunto de reglas y protocolos que permite la comunicación entre diferentes sistemas de software. En el caso de Sicultura, el API proporciona una forma estructurada y programática de acceder a los datos y funcionalidades de la plataforma.
El API de Sicultura es útil porque permite a los desarrolladores interactuar con la información cultural almacenada en la plataforma de una manera automatizada y personalizada. Al utilizar el API, los desarrolladores pueden crear aplicaciones, integraciones y servicios que aprovechen los datos y las funcionalidades de Sicultura para ofrecer nuevas experiencias y soluciones.
Algunos casos de uso del API de Sicultura incluyen:
Integraciones: El API permite integrar Sicultura con otros sistemas y plataformas, como sitios web, aplicaciones móviles o sistemas de gestión internos. Esto facilita la sincronización y el intercambio de datos entre Sicultura y otros sistemas, lo que proporciona una visión holística de la información cultural.
Desarrollo de aplicaciones: Los desarrolladores pueden utilizar el API de Sicultura para crear aplicaciones especializadas que utilicen los datos culturales de la plataforma. Por ejemplo, se pueden desarrollar aplicaciones móviles para explorar eventos culturales, aplicaciones web para gestionar agentes culturales o herramientas de visualización de datos para analizar estadísticas culturales.
Análisis de datos: El API permite acceder a los datos culturales de Sicultura y utilizar herramientas de análisis externas para obtener información valiosa. Los científicos/as de datos pueden extraer datos, realizar análisis y generar visualizaciones personalizadas para comprender mejor las tendencias y patrones culturales.
Automatización de tareas: Mediante el API, se pueden automatizar tareas repetitivas y procesos manuales en Sicultura. Esto incluye la actualización automática de información o la generación de informes personalizados.
En resumen, el API de Sicultura es una poderosa herramienta que permite a desarrolladores y científicos de datos interactuar con los datos y las funcionalidades de la plataforma de manera programática. Esto abre un amplio abanico de posibilidades para desarrollar soluciones personalizadas, integraciones y aplicaciones que enriquezcan la experiencia cultural y optimicen la gestión de recursos en el ámbito cultural.
Ruta base del API
La ruta base del API de Sicultura es la URL principal a la que debes enviar tus solicitudes. Para acceder a los datos del API de Sicultura usa https://sicultura.gob.pa/api.
Estructura de los endpoints
Los endpoints son las URL específicas a las que debes enviar tus solicitudes para acceder a datos o funcionalidades específicas del API. Los endpoints están estructurados de manera lógica y siguen una convención para acceder a los diferentes recursos disponibles en Sicultura. Por ejemplo, podrías tener endpoints como "/agents" para acceder a los agentes culturales, "/spaces" para acceder a los espacios culturales, a continuación se listan los endpoints disponibles:
Categoría | Método | Endpoint |
Agentes culturales | GET | /collections/agents/entries |
Espacios culturales | GET | /collections/spaces/entries |
Eventos culturales | GET | /collections/events/entries |
Manifestaciones culturales | GET | /collections/manifestations/entries |
Programas oficiales | GET | /collections/programs/entries |
Formato de los datos: JSON (JavaScript Object Notation):
El formato en el que se devuelven los datos en el API de Sicultura es JSON (JavaScript Object Notation). JSON es un formato ligero y legible por humanos que se utiliza ampliamente para el intercambio de datos en aplicaciones web. Proporciona una estructura de datos sencilla y flexible que es fácil de entender y procesar tanto por humanos como por máquinas.
En el API de Sicultura, los datos se devuelven en forma de objetos JSON. Cada objeto consiste en pares de clave-valor, donde la clave representa el nombre del atributo y el valor representa el contenido asociado. Los objetos JSON pueden anidarse para crear estructuras de datos más complejas y organizadas.
Al utilizar el API de Sicultura, recibirás respuestas en formato JSON al realizar solicitudes a los diferentes endpoints. Esto te permite acceder a los datos de forma estructurada y utilizarlos en tu aplicación o integración.
Por ejemplo, al solicitar información sobre un agente cultural, puedes recibir una respuesta JSON que incluye los atributos del agente, como nombre, biografía, ubicación, etc. Puedes acceder a estos atributos utilizando la sintaxis de acceso a propiedades de JSON en tu código.
Es importante tener en cuenta que al utilizar el API de Sicultura, debes ser capaz de analizar y procesar los datos en formato JSON en tu aplicación o integración. La mayoría de los lenguajes de programación modernos tienen bibliotecas y métodos incorporados para trabajar con JSON, lo que facilita el procesamiento de los datos recibidos del API.
Limitaciones del API
Es importante tener en cuenta que el API de Sicultura puede tener ciertas limitaciones y restricciones para garantizar un uso equitativo y eficiente de los recursos del sistema.
Límites de solicitudes: Esto se hace para evitar abusos y garantizar un rendimiento óptimo del sistema. Puedes hacer hasta 60 solicitudes por minuto, esto incluye solicitudes a cualquiera de los endpoints, por ejemplo 20 solicitudes al endpoint de agentes culturales, 30 al de espacios y 10 al de programas.
Autenticación y permisos: Solamente podrás usar el método GET para consumir datos a través del API, otros métodos HTTP no están autorizados y devolverán error.
Caché: Cada llamado al API se guarda en memoria durante 60 segundos, si intentas hacer llamados en un tiempo menor, el resultado será exactamente el mismo que la última solicitud.
Ten en cuenta la estructura de los endpoints y las limitaciones del API, al momento de diseñar tu aplicación; esto te permitirá usarlo de manera efectiva y aprovechar al máximo sus capacidades.
Volver al listado de guías