cifraHQ Enterprise
API

OpenAPI 3.0 público. El mismo contrato que usa nuestro frontend.

Esta página resume qué esperar del spec, cómo se autentica, cómo versionamos y por dónde empezar. Para el detalle arquitectónico, consulte la página de plataforma.

Lo esencial

Cuatro cosas que conviene saber antes de integrar

Qué trae el spec

Todos los recursos de negocio

CRUD estándar, PATCH por campo, transiciones de estado como sub-recurso POST. Contratos tipados con ejemplos.

Autenticación

OAuth 2.0 + scopes por dominio

Tokens con scopes explícitos por dominio ERP. Tokens de servicio para integraciones backend, tokens de usuario para UI.

Versionado

SemVer en el path

Versiones mayores en <code>/v1/</code>, <code>/v2/</code>. Cambios compatibles sin bump. Deprecaciones anunciadas con seis meses.

Qué incluye

Contenido del OpenAPI

  • Todos los recursos de los 54 dominios — desde invoices y journalEntries hasta shipments, commissionPlans y landedCosts.
  • Filtros y paginación uniformes. Convención ?field.operator=value en todos los list endpoints; cursor-based pagination en los de alto volumen.
  • Respuestas 409 enriquecidas. Cuando RowVersion no coincide, la respuesta incluye la entidad actual completa — no solo el error.
  • Webhooks tipados. Eventos de negocio (invoice.posted, period.closed), no eventos CRUD. Payload documentado por tipo.
  • Ejemplos ejecutables. Cada endpoint con al menos un payload de request y response en el spec.
Cómo obtener acceso

Spec, sandbox y credenciales

Hoy compartimos el OpenAPI con clientes en evaluación bajo NDA y con socios integradores activos. El sandbox público está en preparación; cuando se publique, vivirá en este dominio y tendrá rate limits generosos para pruebas sin contrato.

Abrir sandbox

URL del sandbox pendiente — contacte ventas para acceso temprano. Le enviamos el spec, credenciales de prueba y un notebook con los primeros flujos (crear cliente, crear factura, postear, cerrar período).

Revíselo con sus integradores

Le enviamos el OpenAPI actual y coordinamos una sesión técnica de 45 minutos para resolver las dudas puntuales de su equipo.

Solicitar el spec