Inicio rápido para desarrolladores
Todo lo de abajo está tomado de la configuración real del gateway, no de una plantilla genérica. Si algún paso no coincide con lo que ves en la consola, toma la consola como fuente autorizada y avísanos.
Inicio rápido
1. Crea una cuenta
El registro pide usuario, nombre visible, correo electrónico y contraseña, y se completa con un código de verificación por correo más un CAPTCHA de imagen. No se requieren datos de pago para darte de alta.
Registrarse →2. Copia tu token de API
A tu cuenta se le emite un único token de API. Lo encuentras en Cuenta → Seguridad → Gestión de token, donde puedes mostrarlo y copiarlo. Hoy no hay rotación autogestionada: si crees que el token quedó expuesto, contáctanos y lo reemitimos.
Abrir Cuenta → Seguridad →3. Recarga tu saldo
Las llamadas son de prepago y se miden una por una. Cada endpoint publica su propio precio unitario en su página de detalle. Si tu saldo no cubre una llamada, el gateway devuelve 402 y la llamada nunca se reenvía a la fuente.
Ver precios →4. Haz tu primera llamada
Sustituye el slug del hub, la ruta y el identificador por los valores del endpoint que quieras llamar. Cada página de detalle de endpoint genera este fragmento por ti en 19 lenguajes, ya con la ruta y los parámetros de ese endpoint.
curl --request GET \
--url 'https://www.apipull.com/gateway/v1/{hub-slug}/curp/query_by_curp?curp=GO**************03' \
--header 'Content-Type: application/json' \
--header 'X-Api-Token: {YOUR_API_TOKEN}'El identificador de abajo es un valor enmascarado de ejemplo, no funciona. Sustitúyelo por uno que tengas base legal para consultar.
Autenticación
La autenticación es un solo encabezado de petición. No hay flujo OAuth, ni firma, ni encabezado Authorization.
| Elemento | Valor |
|---|---|
| Nombre del encabezado | X-Api-Token |
| Alcance | Un token por cuenta, válido para todos los endpoints que tu saldo pueda pagar |
| Rotación | A solicitud — todavía sin regeneración autogestionada |
Formato de la petición
Todos los endpoints viven detrás de un mismo host de gateway. La ruta se compone del slug del hub de la API seguido de la ruta del endpoint que aparece en su página de detalle.
| URL base | https://www.apipull.com/gateway/v1/{hub-slug}{route} |
| Métodos | La mayoría de los endpoints son GET con parámetros de query. Algunos son POST con cuerpo JSON; la página del endpoint indica cuál. |
| Content-Type | application/json para peticiones que llevan cuerpo |
Formato de la respuesta
Las respuestas se transmiten tal como las devuelve la institución que tiene el registro, por lo que la forma del payload difiere entre endpoints. Algunos envuelven el registro en data / status / message / success, otros devuelven el identificador consultado en el nivel superior. Lee siempre la sección Respuesta de la página del endpoint concreto en lugar de suponer un único envoltorio.
Ejemplo — respuesta del endpoint de validación de CURP:
{
"data": {
"statusCurp": "RCN"
},
"status": 200,
"message": "Found",
"success": true
}Límites y cobro
Los límites de tasa y las cuotas gratuitas se configuran por endpoint y se publican en la página de detalle de cada uno, así que revísalos ahí para el endpoint que planeas llamar.
- El límite de tasa se aplica por endpoint; aparece en la sección “Límites y cuota gratuita” de la página del endpoint.
- Las llamadas que no devuelven registro son gratuitas hasta una cuota diaria por endpoint. Pasada esa cuota, un resultado vacío se cobra al precio unitario.
- El saldo se descuenta al momento de la llamada. No hay compromiso mensual ni mínimo.
- Los límites empresariales y cualquier compromiso de nivel de servicio existen únicamente donde así lo diga un contrato firmado aparte.
Manejo de errores
Éstos son los códigos de estado observados en el tráfico de producción. Los códigos no listados no han ocurrido.
| Código | Significado y qué hacer |
|---|---|
200 | La petición llegó a la fuente original y se devolvió una respuesta. Incluye el caso “sin registro”, así que revisa la carga y no solo el código. |
402 | El saldo prepagado no cubría la llamada. La llamada no se realizó y no se cobró nada. Recarga y reintenta. |
504 | La fuente original no respondió a tiempo. Reintenta después; es el modo de falla normal de registros lentos. |
404 | La ruta no existe, o el endpoint ya no está publicado. |
401 | Token de API ausente o inválido. |
Qué esperar en latencia
El tiempo de respuesta lo domina la institución de origen, no nuestro gateway. En las 534 llamadas de producción entre 2026-03-25 y 2026-09-22, el tiempo medio de respuesta fue de 10.0 segundos y el 74.9% devolvió un resultado sustantivo. Algunos endpoints son bastante más lentos que la media.
Diseña para respuestas lentas
- No pongas una llamada sincrónica a nosotros en una ruta donde un usuario esté esperando sin alternativa.
- Configura un timeout de cliente de al menos 30 segundos, y trata el timeout como desconocido, no como resultado negativo.
- Encola el trabajo y notifica al usuario de forma asincrónica cuando el flujo lo permita.
Las cifras se agregan de nuestro propio registro de llamadas, sin muestreo. El desglose completo, incluidas las instituciones de origen y la conservación, está en la página de Uso de datos. Uso y origen de los datos →