Prerrequisitos

Antes de integrar la API necesitas credenciales emitidas por el equipo interno de OCR Platform.

Solicitar API Key

Los integradores no crean API Keys por su cuenta. Contacta al administrador de plataforma de tu organización y proporciona:

Nombre del proyecto o aplicación consumidora.
Ambiente requerido: prueba (ocr_test_...), staging (ocr_staging_...) o producción (ocr_live_...).
Scopes necesarios (ver tabla abajo).
Límites esperados (volumen, tipos de archivo).

Recibirás una clave con formato ocr_test_xxxxxxxx, ocr_staging_xxxxxxxx o ocr_live_xxxxxxxx. Solo se muestra una vez al crearla; guárdala en un secret manager de tu backend.

Nunca expongas la API Key en frontend, apps móviles ni repositorios públicos.

Scopes mínimos

Caso de uso	Scopes
Solo OCR (subir y leer documentos)	`documents:create`, `documents:read`, `results:read`
OCR + extracción	Los anteriores + `extractions:create`, `extractions:read`
Consultar consumo	`usage:read`

Ambientes

Cada API Key pertenece a un proyecto y un ambiente (test, staging, live). Los recursos creados con una key solo son visibles con esa misma key.

Herramientas recomendadas

Postman — pruebas manuales.
cURL — scripts y CI.
Cliente HTTP de tu lenguaje (Laravel HTTP, requests, fetch, etc.).

Checklist antes del primer request

API Key activa y con scopes correctos.
URL base configurada: https://ocr.789.com.mx/v1
Header Idempotency-Key (UUID, 16–191 caracteres) en POST /documents y POST /extractions.
Archivos dentro del límite: 50 MB y 100 páginas en los perfiles actuales (tu API Key o ambiente pueden tener un límite menor).