Ver categorías

API REST: solicitudes y consultas

2 minutos

Consulta — Consultar la base de datos #

Esta operación permite ejecutar una consulta SELECT. La consulta debe seguir un formato específico y presenta ciertas limitaciones:

  • Solo un tipo de entidad por consulta (sin JOIN)
  • Máximo 100 resultados por consulta (utilice LIMIT y OFFSET (para paginar)
  • Las cláusulas WHERE, ORDER BY y LIMIT son opcionales
  • La solicitud debe estar codificada en URL

GET https://apps.kafinea.com/{instance}/webservice.php

Parámetro Tipo Requisitos Descripción
operation cadena sí Debe ser query
sessionName cadena sí Identificador de sesión
query cadena sí Consulta SQL (codificada en URL)

Ejemplo de curl:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=query&sessionName=YOUR_SESSION_ID&query=SELECT%20*%20FROM%20Contacts%20WHERE%20lastname%3D'Dupont'%20LIMIT%2010%20;"

Formato de consulta #

SELECT * | ColumnsList | count(*)
FROM ModuleName
WHERE Conditions
ORDER BY ColumnsList
LIMIT Offset, Limit ;

Importante: el punto y coma final es obligatorio.

Detalles:

Elemento Descripción
ColumnsList Lista de nombres de campos separados por comas
ModuleName Nombre del módulo de la entidad
Conditions Separadas por AND o OR, procesadas de izquierda a derecha. Sin agrupaciones entre paréntesis.
Offset Número entero (opcional)
Limit Entero

Tipos de condiciones disponibles:

Tipo Sintaxis Ejemplo
Operador <, >, <=, >=, !=, = lastname = 'Dupont'
IN IN(val1, val2, ...) industry IN('Tech', 'Finance')
ME GUSTA LIKE 'pattern' lastname LIKE '%dup%'

Consultas relacionadas — Consultar las listas relacionadas #

Esta operación permite obtener las entidades de las listas relacionadas con una entidad específica. La consulta sigue el mismo formato que query, pero sin punto y coma al final.

GET https://apps.kafinea.com/{instance}/webservice.php

Parámetro Tipo Requisitos Descripción
operation cadena sí Debe ser query_related
sessionName cadena sí Identificador de sesión
id cadena sí ID del servicio web de la entidad matriz
relatedLabel cadena sí Nombre del módulo vinculado
query cadena sí Consulta SQL (codificada en URL, sin ; (final)

Ejemplo de curl:

curl "https://apps.kafinea.com/YourKafinea/webservice.php?operation=query_related&sessionName=YOUR_SESSION_ID&id=21x3456&relatedLabel=Documents&query=SELECT%20*%20FROM%20Documents%20WHERE%20filesize%20%3E%2010000"

Ejemplo de consulta:

SELECT * FROM Documents WHERE filesize > 10000

Referencias relacionadas 🔗 #