Postman
Importa la colección oficial para probar la API sin escribir código.
Descargas
| Archivo | Enlace |
|---|---|
| Colección v1 | Descargar colección |
| Entorno local | Descargar entorno local |
| Entorno Railway | Descargar entorno Railway |
Configuración
- Postman → Import → importa la colección y el entorno.
- Selecciona el entorno en la esquina superior derecha.
- Edita variables:
base_url→https://ocr.789.com.mx(sin/v1; la colección ya lo añade)api_key→ tu API Key (solicítala al equipo de plataforma)
Scopes requeridos
documents:create,documents:read,results:readextractions:create,extractions:read(si pruebas extracción)usage:read(si pruebas consumo)
Flujo de prueba
| Paso | Request | Notas |
|---|---|---|
| 1 | Health → Health Live | Sin API Key |
| 2 | Documents → Crear documento | Campo file tipo File |
| 3 | Documents → Detalle documento | Repetir hasta completed o partial_success |
| 4 | Documents → Resultado OCR | format=markdown |
| 5 | Extractions → Crear extracción | Con document_id guardado |
| 6 | Extractions → Resultado extracción | JSON extraído |
Crear documento en Postman
- Body →
form-data(no raw JSON). file→ tipo File → selecciona un PDF.profile→cfdi_invoice(o el perfil que corresponda).output_formats[]→markdown,json.- Header
Idempotency-Key→{{$guid}}.
Documento en queued mucho tiempo
La API encola trabajos en background. Si el documento no avanza, la plataforma lo pasa a failed con document_queue_timeout a los 15 minutos. Si te pasa de forma repetida, contacta al equipo de plataforma con el meta.request_id.