Documentación de la API
Guía completa para desarrolladores - Integra el contenido normativo en tus aplicaciones
API de Signapedia
Acceso automatizado al contenido normativo para desarrolladores
Dentro del contexto de las herramientas tecnológicas con las cuales trabajamos, en el CIEJ nos mantenemos al día con los tiempos que corren. Signapedia cuenta con una API para proveer a los desarrolladores de aplicaciones, el acceso automatizado al contenido de Signapedia para su posterior uso.
🎓 Antes de comenzar
Si no viene del mundo de la programación, puede tener dificultades para comprender el contenido de esta documentación.
Nuestro API endpoint requiere autenticación, para lo cual necesitará contar con las respectivas credenciales (suministradas por el CIEJ) para poder acceder a los recursos de la API.
🌐 Haciendo una solicitud (request) a la API
Las solicitudes a nuestra API necesitan tener Content-Type: application/json y ser enviadas al endpoint correspondiente, como un HTTP GET, POST, PATCH o DELETE. Cuando se está consultando información de la Signapedia, se requiere incluir en el HTTP header, el token de acceso previamente obtenido luego de la autenticación.
🔑 Obtención del access token
curl -H 'Content-Type: application/json' \
-d '{"username":"ejemplo","password":"passwordDeEjemplo"}' \
https://api.ciejvenezuela.com/asamblea/v1/controller/sessions.php
https://api.ciejvenezuela.com/asamblea/v1/controller/sessions.phpEs el endpoint para la obtención del token de acceso, así como para manejar las solicitudes relacionadas con el token de acceso.
📄 Respuesta del access token
{
"statusCode": 201,
"success": true,
"messages": ["Token created"],
"data": {
"session_id": 30,
"access_token": "YjA2NDBkMjQzZjAxM2FjMTNjYmM0ODY4OGJjN2Q2MGUxZjU5MDkxZWY5NjQ0YjA2MTYyMzk0NDY3Ng==",
"access_token_expires_in": 21600,
"refresh_token": "Yzk3OWFjYzQ3ZTY0NWNiNTkzM2VlYjA1MzVkMjFjZmI3ZTA4OGE2NzQxZmY4NTA2MTYyMzk0NDY3Ng==",
"refresh_token_expires_in": 1209600
}
}
🔄 Refresh token
Una vez que expira el access_token (luego de transcurridas 6 horas desde su creación), será necesario reemplazarlo por uno nuevo utilizando el refresh_token obtenido cuando se creó el access_token.
curl -H 'Content-Type: application/json' \
-H 'Authorization: YjA2NDBkMjQzZjAxM2FjMTNjYmM0ODY4OGJjN2Q2MGUxZjU5MDkxZWY5NjQ0YjA2MTYyMzk0NDY3Ng==' \
--request PATCH \
-d '{"refresh_token": "Yzk3OWFjYzQ3ZTY0NWNiNTkzM2VlYjA1MzVkMjFjZmI3ZTA4OGE2NzQxZmY4NTA2MTYyMzk0NDY3Ng=="}' \
https://api.ciejvenezuela.com/asamblea/v1/controller/sessions.php?sessionid=30
📊 Consulta de fichas
Una vez tenemos un token de acceso (access_token) válido, podemos consultar la información de Signapedia (fichas).
curl -H 'Content-Type: application/json' \
-H 'Authorization: MDM5ZjczN2Y5ZTFhMmJhYWRiNmE1ZDdjM2Q5N2FjMDY5OWY0ZmZmYTIwMzQ3MzU3MTYyMzk1NzcyMQ==' \
https://api.ciejvenezuela.com/asamblea/v1/controller/fichas.php
https://api.ciejvenezuela.com/asamblea/v1/controller/fichas.phpEs el endpoint para consultar las fichas y solo acepta el método GET.
🔍 Filtros disponibles
titulo
Filtra por palabras en el título del acto
?titulo=Decreto
vigente
Filtra por estado de vigencia
?vigente=Sí o ?vigente=No
tipo_acto
Filtra por tipo de acto normativo
?tipo_acto=Ley
autor_acto
Filtra por órgano emisor
?autor_acto=Congreso
sector
Filtra por sector competencial
?sector=Finanzas
materia
Filtra por materia especializada
?materia=Tributos
¿Listo para integrar la API?
Comienza a desarrollar con Signapedia hoy mismo