P4 Software / cifrahq-spanish

API de CifraHQ

Cómo Conectarse a la API de CifraHQ

Tus datos contables no deberían vivir en un silo. La API REST de CifraHQ te permite conectar sistemas externos - plataformas de comercio electrónico, sistemas de gestión de almacenes, aplicaciones de terceros o tus propias herramientas personalizadas - directamente con tus datos de CifraHQ. Crea pedidos, registra Facturas, sincroniza Clientes, extrae datos financieros: todo lo que está disponible en la interfaz está disponible a través de la API.

La referencia interactiva completa - cada endpoint, esquemas de solicitud y respuesta, y una consola de pruebas integrada - se encuentra en:

https://app.cifrahq.cloud/developers

Autenticación

Cada solicitud a la API requiere un token Bearer en el encabezado Authorization:

Authorization: Bearer <tu-token-de-api>

Para obtener tu token de API:

  1. Inicia sesión en tu tenant de CifraHQ.
  2. Ve a Configuración > Usuarios y abre tu registro de usuario.
  3. Genera o copia tu token de API desde el campo Token de API.

Mantén tu token en privado - proporciona el mismo nivel de acceso a tus datos que tu cuenta de usuario.

URL Base

La URL base de tu API sigue este patrón:

https://{tuempresa}.CifraHQ.cloud/api/

Reemplaza {tuempresa} con el subdominio de tu tenant - el mismo que usas para iniciar sesión en {tuempresa}.CifraHQ.cloud.

Endpoints comunes

Operación Patrón del endpoint
Listar registros (con filtrado) GET data/qry/{TableName}?cols=...&where=...
Obtener un registro por ID GET api/{Entity}/GetById?id={id}
Crear o actualizar un registro POST api/{Entity}/CreateOrUpdate
Contabilizar un documento POST api/{Entity}/Post
Eliminar un registro POST api/{Entity}/Delete

Consejos

  • El endpoint data/qry/ se comporta como una consulta SQL parametrizada - usa cols, where, joins, order, limit y offset para extraer exactamente los datos de lista que necesitas, incluidas uniones entre tablas, sin necesidad de escribir un endpoint personalizado.
  • Todos los IDs de entidad en CifraHQ son GUIDs. Almacénalos como cadenas de texto; no los trunces ni reformates.
  • Las fechas utilizan el formato ISO 8601: 2025-04-24T00:00:00Z.
  • Todas las solicitudes y respuestas usan application/json.

Referencia completa de la API: https://app.cifrahq.cloud/developers

Relacionado: Usuarios · Webhooks · Flujos de Trabajo

Was this page helpful?