Documentación API
Integra consultas electorales, antecedentes y digitalización de documentos en tus aplicaciones.
La API de Avappi ofrece múltiples servicios para consultar información de ciudadanos colombianos de manera rápida y confiable. Ideal para campañas políticas, verificaciones de identidad, y digitalización de documentos.
https://avappi.up.railway.app/
Precios
Todos los precios están en Pesos Colombianos (COP). El saldo se descuenta automáticamente por cada consulta exitosa.
Nota: Clientes Enterprise pueden negociar tarifas personalizadas.
Autenticación
Todas las peticiones deben incluir tu API Key. Puedes obtener una registrándote en nuestro dashboard.
Métodos de envío
| Método | Parámetro | Ejemplo |
|---|---|---|
| Header (Recomendado) | X-API-Key |
X-API-Key: sk_live_123... |
| Query Param | apiKey |
?apiKey=sk_live_123... |
Consulta Individual (Censo)
Obtén la información de votación de una sola cédula. Costo: $80 COP
Ejemplo de Solicitud
curl -X GET "https://avappi.up.railway.app/consultar/1234567890" \
-H "X-API-Key: tu_api_key"
Respuesta Exitosa
{
"success": true,
"data": {
"departamento": "BOGOTA D.C.",
"municipio": "BOGOTA D.C.",
"puesto": "COLEGIO NUEVA GRANADA",
"direccion": "CR 2 E # 70 - 20",
"mesa": "1"
},
"duration": 1245,
"fromCache": false
}
Consulta Masiva (Censo)
Consulta hasta 10 cédulas en una sola petición. Costo: $80 COP × cantidad de cédulas
Body (JSON)
{
"cedulas": ["1234567890", "9876543210"]
}
Ejemplo de Solicitud
curl -X POST "https://avappi.up.railway.app/consultar/bulk" \
-H "X-API-Key: tu_api_key" \
-H "Content-Type: application/json" \
-d '{"cedulas": ["1234567890", "9876543210"]}'
Consulta Procuraduría
Consulta antecedentes disciplinarios por nombre en la Procuraduría General de la Nación. Costo: $20 COP
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
nombre |
string | Nombre completo a consultar (URL encoded) |
Ejemplo de Solicitud
curl -X GET "https://avappi.up.railway.app/procuraduria/JUAN%20PEREZ%20GARCIA" \
-H "X-API-Key: tu_api_key"
Respuesta Exitosa
{
"success": true,
"data": {
"nombre": "JUAN PEREZ GARCIA",
"resultado": "No registra antecedentes",
"fecha_consulta": "2024-01-15T10:30:00Z"
},
"fromCache": false
}
Digitalización de Documentos
Extrae datos estructurados de documentos mediante OCR. Costo: $100 COP por registro
Headers
| Header | Valor |
|---|---|
Content-Type |
multipart/form-data |
X-API-Key |
Tu API Key |
Body (Form Data)
| Campo | Tipo | Descripción |
|---|---|---|
file |
File | Imagen del documento (JPG, PNG, PDF) |
type |
string | Tipo de documento: cedula, e14, general |
Ejemplo con cURL
curl -X POST "https://avappi.up.railway.app/api/digitization" \
-H "X-API-Key: tu_api_key" \
-F "file=@documento.jpg" \
-F "type=cedula"
Respuesta Exitosa
{
"success": true,
"records": 1,
"data": [
{
"nombre": "JUAN PEREZ GARCIA",
"cedula": "1234567890",
"fecha_nacimiento": "1990-05-15",
"confidence": 0.95
}
],
"cost": 100
}
Códigos de Error
| Código | Descripción |
|---|---|
400 |
Solicitud inválida. Verifica los parámetros enviados. |
401 |
API Key inválida o faltante. |
402 |
Saldo insuficiente. Recarga en el dashboard. |
429 |
Límite de velocidad excedido (60 req/min). |
500 |
Error interno del servidor. |
503 |
Servicio externo no disponible (Registraduría, Procuraduría). |
Avappi