P4 Software / cifrahq-es

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 debe incluir tu clave de API en el encabezado ApiKey:

ApiKey: <tu-clave-de-api>

Para obtener tu clave de API:

  1. Inicia sesión en tu tenant de CifraHQ.
  2. Ve a Configuración > Usuarios y abre tu registro de usuario.
  3. Copia el valor del campo Clave de API.

Mantén tu clave 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 (paginado) GET api/{Entity}/GetList?skip=0&take=100
Buscar registros (texto libre) GET api/{Entity}/Search?q={término}
Listar registros (filtrado avanzado) 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

Listar y buscar registros

Cada entidad expone dos endpoints de lectura que no requieren construir consultas:

  • GET api/{Entity}/GetList devuelve una página de registros, del más reciente al más antiguo. Usa skip y take para paginar (take predeterminado 100, máximo 200).
  • GET api/{Entity}/Search devuelve los registros cuyos campos de texto contienen un término de búsqueda. Pasa el término en q y pagina con skip y take (take predeterminado 50, máximo 200). Un término vacío devuelve la primera página de todos los registros.

Ambos devuelven un arreglo JSON plano con los campos propios de cada registro (sin registros relacionados anidados).

# Las primeras 2 órdenes de venta
curl -H "ApiKey: <tu-clave-de-api>" \
     "https://{tuempresa}.CifraHQ.cloud/api/SalesOrder/GetList?take=2"

# Buscar Clientes cuyo nombre, código, correo o RUC contenga "acme"
curl -H "ApiKey: <tu-clave-de-api>" \
     "https://{tuempresa}.CifraHQ.cloud/api/Customer/Search?q=acme"

{Entity} es el nombre singular de la entidad - Customer, Vendor, Product, Warehouse, SalesOrder, Invoice, PurchaseOrder, etc. Consulta la lista completa en la referencia interactiva.

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

¿Te resultó útil esta página?

Anterior CifraHQ Siguiente Novedades