Skip to main content
La API de ImpactU es una API REST de solo lectura que devuelve información científica y académica en formato JSON: personas, productos, afiliaciones, fuentes, patentes, proyectos y entidades geográficas.

​
URL base

Todas las rutas de esta documentación se agregan a esa URL. Por ejemplo, GET /search/works se consulta en https://api.dev.impactu.colav.co/search/works.

​
Formato de las respuestas

Las respuestas son JSON y tienen dos formas, según el tipo de endpoint.
Los endpoints que devuelven una sola entidad envuelven el resultado en data y agregan meta, con la misma forma que en los listados (count vale 1).
Algunos endpoints devuelven el objeto sin envolver en data: los filtros disponibles, las afiliaciones relacionadas (de una afiliación o de una entidad geográfica), /info y /info/quality. Las exportaciones devuelven un archivo CSV o Excel.

​
Campo meta de los listados

​
object
Metadatos de la respuesta.

​
Convenciones de los listados

Los endpoints de búsqueda comparten estos parámetros de consulta.
​
string
Texto de búsqueda. Se usa en las búsquedas desde caja de texto.
​
integer
default:"10"
Resultados por página, de 1 a 250.
​
integer
default:"1"
Número de página.
​
string
default:"citations_desc"
Ordenamiento con el formato campo_direccion, donde la dirección es asc o desc. Los campos válidos dependen de la entidad y se describen en cada endpoint.
​
string
default:"full"
Nivel de detalle de la respuesta: full (todos los campos) o summary (solo los campos principales). Lo aceptan los listados y los detalles de las entidades, salvo la búsqueda y el detalle de entidades geográficas y las noticias.
Además, cada listado tiene sus propios filtros. Todos aceptan varios valores separados por coma (por ejemplo, years=2020,2026), y las opciones válidas se consultan en el endpoint de filtros disponibles de cada entidad.
Si no envías max, page ni sort, se aplican max=10, page=1 y sort=citations_desc. Si envías max y page sin sort, se aplica sort=citations_desc.

​
Datos y formatos

Las fechas se expresan en segundos Unix. En las fechas de fin, un valor -1 indica que la relación sigue vigente.
Cada entidad tiene su propio formato de identificador:
Muchos campos (nombres, citas, tipos, rankings) devuelven un elemento por cada fuente de información, con los campos source y provenance.

​
Autenticación y límites

Los endpoints de consulta son públicos: no requieren autenticación y por ahora no tienen límite de solicitudes. Requieren sesión la administración de usuarios (/admin/users), la gestión del API Key (/users/{email}/apikey), el estado de sesión (/me) y la carga de archivos en /submit/staff, /submit/ciarp y /submit/scienti. La sesión es el JWT que Iniciar sesión guarda en la cookie HttpOnly access_token_cookie.

​
Errores

Cuando una solicitud falla, la API responde con el código HTTP del caso y un mensaje en error:
Los endpoints de autenticación, usuarios y carga de archivos responden con { "success": false, "msg": "..." } en lugar de error, salvo Validar archivo de proyectos. Los listados de una entidad que no existe (por ejemplo, los productos de un autor inexistente) responden 200 con la lista vacía.

​
Endpoints disponibles

Search

Búsqueda de personas, productos, afiliaciones, fuentes, patentes, proyectos y geografía, con sus endpoints de filtros disponibles.

Affiliation

Consulta de una afiliación (institución, facultad, departamento o grupo) por su identificador.