Piénsala como la contraseña de tu cuenta. Cada vez que uses la API, la envías para identificarte. Así sabemos quién eres y cuántas facturas has procesado.
1. Ve a invoiceextract.com.mx
2. Haz clic en el botón "API Key gratis"
3. Escribe tu email y haz clic en "Generar API key"
4. Revisa tu correo — te llegará un email con tu key. Se ve así:
# Tu API key se ve así (la tuya será diferente):
iek_a3f8d2c1e5b7f9d4c8e2a6b0d1f3e5c7
Imagina que eres un cliente en un restaurante. Tú no vas a la cocina a preparar tu comida — le dices al mesero qué quieres, él va a la cocina, y te trae el resultado. Una API es el mesero. Tú le dices qué necesitas (una factura), él procesa la información, y te devuelve el resultado (el JSON con los datos).
En términos prácticos: tu programa envía una factura a nuestra API, y recibe de vuelta los datos en formato JSON — un formato que cualquier programa puede entender fácilmente.
JSON es una forma de organizar información que los programas pueden leer. Se ve así:
{
"nombre": "Juan Pérez",
"edad": 30,
"ciudad": "Ciudad de México"
}
Cuando le envías una factura a nuestra API, te devuelve algo así — pero con los datos de la factura:
{
"emisor": "Papelería El Centro S.A.",
"total": 7052.80,
"moneda": "MXN",
"fecha": "2024-11-15"
}
Vamos a probar la API usando una herramienta gratuita que funciona en el navegador. No necesitas instalar nada.
1. Ve a hoppscotch.io — es gratis y funciona en el navegador
2. Cambia el método de GET a POST
3. Escribe la URL: https://invoiceextract-api-production.up.railway.app/extract
4. En la pestaña Headers agrega:
— Key: x-api-key
— Value: tu-key-aqui
5. En la pestaña Body → raw → JSON pega esto:
{
"url": "https://invoiceextract-api-production.up.railway.app/health"
}
tu-key-aqui con la API key que recibiste en tu email en el Paso 1.Si tienes Windows, abre PowerShell (busca "PowerShell" en el menú inicio) y pega esto:
# Reemplaza TU_KEY con tu API key real $key = "iek_TU_KEY_AQUI" $base = "https://invoiceextract-api-production.up.railway.app" Invoke-RestMethod -Uri "$base/keys/usage" ` -Headers @{"x-api-key" = $key}
Aquí eliges cómo vas a usar la API según lo que ya sabes o el programa que estás construyendo.
Primero instala la librería requests si no la tienes:
pip install requests
Copia este código, reemplaza iek_TU_KEY con tu key real y cambia la ruta del archivo PDF:
import base64 import requests # 1. Tu API key API_KEY = "iek_TU_KEY_AQUI" # 2. La ruta a tu factura PDF ARCHIVO = "mi_factura.pdf" # 3. Convierte el PDF a base64 with open(ARCHIVO, 'rb') as f: pdf_base64 = base64.b64encode(f.read()).decode() # 4. Envía a la API respuesta = requests.post( 'https://invoiceextract-api-production.up.railway.app/extract', headers={'x-api-key': API_KEY}, json={'file_base64': pdf_base64, 'media_type': 'application/pdf'}, ) # 5. Lee los resultados datos = respuesta.json()['data'] print(f"Emisor: {datos['issuer']['name']}") print(f"Total: ${datos['amounts']['total']} {datos['document']['currency']}") print(f"Fecha: {datos['document']['date']}") print(f"Confianza: {datos['confidence'] * 100:.0f}%")
No necesitas instalar nada extra. Guarda esto como factura.js y ejecuta con node factura.js:
const fs = require('fs'); // 1. Tu API key y archivo const API_KEY = 'iek_TU_KEY_AQUI'; const ARCHIVO = 'mi_factura.pdf'; // 2. Convierte y envía const base64 = fs.readFileSync(ARCHIVO).toString('base64'); const res = await fetch( 'https://invoiceextract-api-production.up.railway.app/extract', { method: 'POST', headers: { 'x-api-key': API_KEY, 'Content-Type': 'application/json' }, body: JSON.stringify({ file_base64: base64, media_type: 'application/pdf' }), } ); const { data } = await res.json(); console.log(`Emisor: ${data.issuer.name}`); console.log(`Total: $${data.amounts.total} ${data.document.currency}`);
Ahora que sabes los conceptos básicos, aquí hay algunas ideas de lo que puedes construir:
📊 Automatizar tu contabilidad — procesa todas tus facturas automáticamente y súbelas a una hoja de cálculo
🔍 Buscador de facturas — extrae los datos de cientos de facturas y construye un buscador por fecha, proveedor o monto
📱 App de gastos — fotografía un recibo y extrae el total automáticamente
🤖 Bot de Slack/WhatsApp — manda una factura y recibe los datos al instante
Si ya te sientes listo para ver la documentación técnica completa con todos los detalles:
Responde el email que te enviamos con tu API key y te ayudamos personalmente. No importa si la pregunta parece básica — estamos para eso.