API Documento Técnico
latest
  • API v.2
  • API v.1
API Documento Técnico
  • Docs »
  • Content
  • Edit on GitHub

Content¶

  • API v.2
    • 1. Introducción
    • 2. Autorización
    • 3. Recursos
    • 4. Métodos
      • GET Listados
      • GET
      • POST / PUT / PATCH
        • Datasets
        • Datastreams
      • Estructura JSON
        • Modificar el formato de salida
  • API v.1
    • 1. Junar API
      • 1.1 Snippets de código y API Wrappers
      • 1.2 Metodos para consumir Vistas de Datos
        • 1.2.1 Consumiendo una Vista de Datos
        • 1.2.2 URL
        • 1.2.3 Métodos de consulta soportados
        • 1.2.4 Parámetros
        • 1.2.5 Ejemplo
        • 1.2.6 Ejemplo de formato de salida
        • 1.2.7 Consumiendo una vista con parámetros
        • 1.2.8 Filtrar los resultados de una vista
        • 1.2.9 Formateo de Datos
      • 1.3 Métodos para accesar objetos
        • 1.3.1 Información de vistas de datos
        • 1.3.2 Información de Vista de Datos con Parámetros
        • 1.3.3 Información de las Colecciones
      • 1.4 Métodos para realizar búsquedas
        • 1.4.1 Buscar Vistas de Datos
        • 1.4.2 Búsqueda de Colecciones
        • 1.4.3 Opciones de Búsqueda
      • 1.5 Métodos para obtener métricas para una cuenta de datos abiertos
      • 1.6 Manejo de Errores

La API de DATAL debe seguir en la medida de lo posible las guias de diseño del Gobierno de Chile, expuestas en https://github.com/e-gob/api-standards.

En resumen, se estructurarán las URLs de la API siguiendo el patrón REST, asignando URLs a recursos, utilizando los verbos GET, POST, PUT, PATCH, DELETE para las correspondientes acciones y la extension del formato en que se recibiran los resultados, por ejemplo:

GET /api/v2/datasets/12345.json

para solicitar un dataset identificado por el ID 12345 en formato JSON.

Next

© Copyright 2015, Junar. Revision bdf0b76c.

Built with Sphinx using a theme provided by Read the Docs.