Documentación de la API de GEFRI

La API del Índice Global de Preparación para el Futuro de la Educación (GEFRI) ofrece acceso abierto a datos por país y resúmenes globales para que investigadores, desarrolladores y responsables de políticas puedan analizar, comparar y descargar resultados actualizados de GEFRI. La API es pública y no requiere autenticación.

Versión: 1.0   |   Formato: JSON

Inicio rápido: consultas de ejemplo

• Obtener todos los países (resumen global):

  curl https://gefri.educationfutures.com/api/gefri

• Obtener el perfil completo de Aruba (por código ISO3):

  curl https://gefri.educationfutures.com/api/gefri?code=ABW

• Obtener varios países por código:

  curl "https://gefri.educationfutures.com/api/gefri?codes=USA,FIN,BRA"

• Obtener todos los países de América Latina y el Caribe, ordenados por puntuación (descendente):

  curl "https://gefri.educationfutures.com/api/gefri?region=lac&sort=score&order=desc"

• Devolver solo campos seleccionados (código de país y puntuación compuesta):

  curl "https://gefri.educationfutures.com/api/gefri?fields=country code,score"

• Devolver solo indicadores específicos de un país:

  curl "https://gefri.educationfutures.com/api/gefri?code=ABW&indicators=SE.SEC.UNER.LO.ZS,EG.ELC.ACCS.ZS"

• Recuperar una instantánea histórica (diciembre de un año determinado):

  curl "https://gefri.educationfutures.com/api/gefri?year=2023&codes=FIN,SWE"

Uso básico y parámetros de consulta

• Todos los países (predeterminado):
  /api/gefri
• Un solo país por código ISO3:
  /api/gefri?code=FIN
• Varios países por código ISO3:
  /api/gefri?codes=FIN,USA,BRA
• Por región (sin distinguir mayúsculas y con alias como "LAC" o "EAP"):
  /api/gefri?region=lac
• Ordenar resultados (por defecto, descendente para números):
  /api/gefri?sort=score&order=asc
• Devolver solo campos específicos de nivel superior:
  /api/gefri?fields=country name,score,region
• Obtener campos con alias (shortnames):
  /api/gefri?shortnames=true
• Seleccionar una instantánea histórica (diciembre de un año determinado):
  /api/gefri?year=2023

  Los archivos históricos se almacenan por mes. Especifique el año para recuperar la instantánea de diciembre de ese año; la API devuelve 404 si el archivo no está disponible.

Indicadores a nivel de país

• Filtrar detalles de indicadores (por código, separados por comas y sin distinguir mayúsculas):
  /api/gefri?code=ABW&indicators=SE.SEC.UNER.LO.ZS,EG.ELC.ACCS.ZS
• La matriz indicator_details solo se incluye en resultados a nivel de país.

Ordenación

• Ordenar por cualquier campo:
  /api/gefri?sort=score&order=desc
• Orden ascendente:
  /api/gefri?sort=score&order=asc
• Orden alfabético:
  /api/gefri?sort=Country Name&order=asc

Estructura de respuesta y manejo de errores

{
  "level": "country",
  "snapshot": "current",
  "count": 1,
  "data": {
    "Country Name": "Aruba",
    "Country Code": "ABW",
    "Region": "Latin America & Caribbean",
    "Composite GEFRI Score": 67.8,
    // ...other fields...
    "indicator_details": [
      {
        "indicator_code": "SP.POP.TOTL",
        "indicator_name": "Population, total",
        "component": null,
        "year": 2023,
        "reported_value": 41454761,
        "data_source": "World Bank",
        "normalized_value": null,
        "global_percentile": null,
        "regional_percentile": null,
        "notes": ""
      }
      // ...etc...
    ]
  }
}

Manejo de errores: Si una solicitud es inválida, la respuesta incluye una clave error con un mensaje descriptivo. Por ejemplo:
{ "error": "Country code not found" }

Diccionario de datos

Cada objeto de la API de GEFRI incluye los siguientes campos. La disponibilidad puede variar. Todas las puntuaciones están normalizadas en una escala de 0 a 100, salvo que se indique lo contrario. Population, total se utiliza solo como serie auxiliar y no interviene en ninguna puntuación de GEFRI.

indicator_details (matriz, solo por país): cada objeto contiene:

Notas:
- indicator_details solo aparece en resultados de API por país.
- data_source siempre se incluye para la trazabilidad.
- Los percentiles se devuelven como cadenas ordinales ("84th", "63rd"), no como números.

Alias compatibles

Utilice estos alias para simplificar sus consultas.

Notas y atribución

• Los datos se actualizan mensualmente. Los indicadores provienen de datos abiertos, principalmente World Bank Open Data. World Bank Open Data.
• Cuando utilice GEFRI en investigación o aplicaciones, cite a Education Futures.
• Para comentarios o colaboración, contáctenos. contacto.