Exclusivo plan Premium

Documentación API REST

Integra cualquier aplicación con tu CRM. Consulta, crea, actualiza y elimina registros de forma segura mediante nuestra API REST.

Endpoint:


https://tu_crm.opencrm.es/webservice.php

Introducción

La API REST de OpenCRM permite integrar cualquier aplicación de terceros con tu CRM. Puedes consultar, crear, actualizar y eliminar registros de prácticamente cualquier módulo del sistema de forma segura mediante peticiones HTTP estándar.

Plan Premium requerido

El acceso a la API REST es una funcionalidad exclusiva del plan OpenCRM Premium. Contacta con nosotros si necesitas activarla en tu cuenta.

Todas las solicitudes deben incluir como mínimo el parámetro operation, que indica qué acción se desea ejecutar.

Endpoint base

Todas las llamadas a la API se realizan contra la misma URL. Sustituye tu_crm por el subdominio de tu instalación:

HTTPS https://tu_crm.opencrm.es/webservice.php

El parámetro operation debe estar presente en todas las llamadas a la API.

Autenticación

La API requiere autenticación en 2 pasos: primero obtienes un token temporal y luego lo combinas con tu Access Key para iniciar sesión y recibir un sessionId.

Access Key ≠ Contraseña

El Access Key es distinto a tu contraseña habitual. Lo encontrarás en Mis Preferencias, en la parte inferior de la pantalla. Las operaciones disponibles se limitan a los permisos del usuario con el que inicies sesión.

GET

getchallenge

Solicita un token temporal para el usuario indicado. Este token expira en pocos minutos.

Parámetro	Valor	Descripción
`operation`	`getchallenge`	Operación fija
`username`	string	Nombre de usuario del CRM

Respuesta

{
  "success": true,
  "result": {
    "token": "TOKEN_VALIDO",
    "serverTime": 1720000000,
    "expireTime": 1720000600
  }
}

POST

login

Combina el token con tu Access Key mediante MD5 y envía la petición de login en formato form-data.

Fórmula accessKey = MD5( token + Access_Key_del_usuario )

Parámetro	Valor	Descripción
`operation`	`login`	Operación fija
`username`	string	Nombre de usuario
`accessKey`	string	MD5(token + Access Key)

Respuesta

{
  "success": true,
  "result": {
    "sessionId": "SESSION_ID",
    "userId": "19x1",
    "version": "0.1"
  }
}

Guarda el sessionId — es obligatorio en todas las llamadas posteriores junto con el parámetro operation.

Operaciones disponibles

Las siguientes operaciones permiten gestionar registros de cualquier módulo del CRM: Contactos, Cuentas, Leads, Oportunidades, Presupuestos, Pedidos, Facturas y más.

Formato de ID de registro

Cada registro se identifica con el formato 14x35452: el número antes de la x es el ID del módulo y el de después es el ID interno del registro. Usa DESCRIBE para conocer el ID de cada módulo.

GETDESCRIBEMetadatos de un módulo POSTCREATECrear un registro GETRETRIEVELeer un registro POSTUPDATEActualizar completo POSTREVISEActualización parcial POSTDELETEEliminar registro GETQUERYConsulta SQL

GET

DESCRIBE

Devuelve los metadatos del módulo: campos, tipos, campos obligatorios, operaciones soportadas e identificador del módulo.

Parámetro	Descripción
`operation`	Siempre `describe`
`sessionName`	sessionId obtenido en el login
`elementType`	Nombre del módulo: `Contacts`, `Accounts`, `Leads`…

POST

CREATE

Crea un nuevo registro. La petición debe ser POST con parámetros en formato form-data.

Parámetro	Descripción
`operation`	Siempre `create`
`sessionName`	sessionId del login
`elementType`	Nombre del módulo
`element`	JSON con los datos del registro (incluye al menos los campos obligatorios)

Usa DESCRIBE para conocer qué campos son obligatorios. Si la creación es correcta, la respuesta incluye el id del nuevo registro.

GET

RETRIEVE

Obtiene todos los datos de un registro a partir de su ID.

Parámetro	Descripción
`operation`	Siempre `retrieve`
`sessionName`	sessionId del login
`id`	ID del registro en formato `14x35452`

POST

UPDATE

Actualiza un registro existente. Todos los campos deben incluirse en element: cualquier campo omitido quedará en blanco.

Parámetro	Descripción
`operation`	Siempre `update`
`sessionName`	sessionId del login
`element`	JSON con todos los campos del registro, incluyendo `id` y `assigned_user_id`

UPDATE sobreescribe el registro completo. Si solo necesitas modificar algunos campos, usa REVISE.

POST

REVISE

Actualización parcial. Solo se actualizan los campos incluidos en element; el resto permanece sin cambios. Más eficiente que UPDATE.

Parámetro	Descripción
`operation`	Siempre `revise`
`sessionName`	sessionId del login
`element`	JSON con el `id` del registro y solo los campos a modificar

POST

DELETE

Mueve un registro a la Papelera de Reciclaje. Puede restaurarse desde el CRM.

Parámetro	Descripción
`operation`	Siempre `delete`
`sessionName`	sessionId del login
`id`	ID del registro en formato `14x35452`

GET

QUERY

Ejecuta una consulta SQL sobre los datos del CRM para listar y filtrar registros.

Parámetro	Descripción
`operation`	Siempre `query`
`sessionName`	sessionId del login
`query`	Consulta SQL (URL-encoded)

Sintaxis SQL soportada

SELECT * | <columnas> | count(*)
FROM <módulo>
[WHERE <condiciones>]
[ORDER BY <columnas>]
[LIMIT [offset,] n]

Limitaciones importantes

Máximo 100 registros por consulta. Usa LIMIT con offset para paginar.
Solo se admiten consultas sobre un único módulo. Los JOINs no están soportados.
Operadores: = != < > <= >= IN LIKE

Operaciones Personalizadas

Las operaciones estándar cubren la mayoría de casos de integración. Si tu caso de uso requiere una función personalizada, podemos desarrollarla para ti.

¿Necesitas algo más específico?

Nuestro equipo puede desarrollar operaciones personalizadas adaptadas a tus necesidades concretas de integración.

Contactar con soporte

 BASE_URL="https://tu_crm.opencrm.es/webservice.php" 
 const BASE_URL = 'https://tu_crm.opencrm.es/webservice.php'; 
 $baseUrl = 'https://tu_crm.opencrm.es/webservice.php'; 
 curl "$BASE_URL?operation=getchallenge&username=admin" 
 const BASE_URL = 'https://tu_crm.opencrm.es/webservice.php';

const res = await fetch(`${BASE_URL}?operation=getchallenge&username=admin`); 
 $baseUrl = 'https://tu_crm.opencrm.es/webservice.php';
$url = $baseUrl . '?operation=getchallenge&username=admin'; 
 BASE_URL="https://tu_crm.opencrm.es/webservice.php"

# Paso 1: obtener token
TOKEN=$(curl -s "$BASE_URL?operation=getchallenge&username=admin" \
  | python3 -c "import sys,json; \
    print(json.load(sys.stdin)['result']['token'])")

# Calcular accessKey = MD5(token + Access Key)
ACCESS_KEY="tu_access_key_aqui"
MD5_KEY=$(printf '%s' "${TOKEN}${ACCESS_KEY}" \
  | md5sum | cut -d' ' -f1)

# Paso 2: login
SESSION=$(curl -s -X POST "$BASE_URL" \
  -d "operation=login" \
  -d "username=admin" \
  -d "accessKey=${MD5_KEY}" \
  | python3 -c "import sys,json; \
    print(json.load(sys.stdin)['result']['sessionId'])") 
 // npm install md5
import md5 from 'md5';

const BASE_URL = 'https://tu_crm.opencrm.es/webservice.php';

// Paso 1: getchallenge
const r1 = await fetch(
  `${BASE_URL}?operation=getchallenge&username=admin`
);
const { result: { token } } = await r1.json();

// accessKey = MD5(token + Access Key del usuario)
const accessKey = md5(token + 'TU_ACCESS_KEY');

// Paso 2: login
const body = new URLSearchParams({
  operation: 'login', username: 'admin', accessKey,
});
const r2 = await fetch(BASE_URL, { method: 'POST', body });
const { result: { sessionId } } = await r2.json(); 
 $baseUrl = 'https://tu_crm.opencrm.es/webservice.php';
$username = 'admin';
$userAccessKey = 'TU_ACCESS_KEY';

// Paso 1: getchallenge
$ch = curl_init("$baseUrl?operation=getchallenge&username=$username");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);
$token = $data['result']['token'];
curl_close($ch);

// accessKey = MD5(token + Access Key)
$accessKey = md5($token . $userAccessKey);

// Paso 2: login
$ch = curl_init($baseUrl);
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS     => http_build_query([
        'operation' => 'login',
        'username'  => $username,
        'accessKey' => $accessKey,
    ]),
]);
$data = json_decode(curl_exec($ch), true);
$sessionId = $data['result']['sessionId'];
curl_close($ch); 
 curl "$BASE_URL\
  ?operation=getchallenge\
  &username=admin" 
 const res = await fetch(
  `${BASE_URL}?operation=getchallenge&username=admin`
);
const { result } = await res.json();
const token = result.token; 
 $url = $baseUrl . '?' . http_build_query([
    'operation' => 'getchallenge',
    'username'  => 'admin',
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);
$token = $data['result']['token'];
curl_close($ch); 
 ACCESS_KEY="tu_access_key"
MD5_KEY=$(printf '%s' "${TOKEN}${ACCESS_KEY}" \
  | md5sum | cut -d' ' -f1)

curl -X POST "$BASE_URL" \
  -d "operation=login" \
  -d "username=admin" \
  -d "accessKey=${MD5_KEY}" 
 import md5 from 'md5'; // npm install md5

const accessKey = md5(token + 'TU_ACCESS_KEY');

const body = new URLSearchParams({
  operation: 'login',
  username: 'admin',
  accessKey,
});
const res = await fetch(BASE_URL, { method: 'POST', body });
const { result } = await res.json();
const sessionId = result.sessionId; 
 $accessKey = md5($token . 'TU_ACCESS_KEY');

$ch = curl_init($baseUrl);
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS     => http_build_query([
        'operation' => 'login',
        'username'  => 'admin',
        'accessKey' => $accessKey,
    ]),
]);
$data = json_decode(curl_exec($ch), true);
$sessionId = $data['result']['sessionId'];
curl_close($ch); 
 # ID de registro: ModuloID x RegistroID
# Ej: 12x56789 → módulo 12, registro 56789

# Obtener metadatos de un módulo (incluye su ID)
curl "$BASE_URL\
  ?operation=describe\
  &sessionName=${SESSION}\
  &elementType=Contacts" 
 // ID de registro: "12x56789"
// Usa DESCRIBE para conocer el ID de cada módulo

const params = new URLSearchParams({
  operation:   'describe',
  sessionName: sessionId,
  elementType: 'Contacts',
});
const res = await fetch(`${BASE_URL}?${params}`);
const { result } = await res.json();
// result.idPrefix → ID del módulo 
 // ID de registro: "12x56789"
// Usa DESCRIBE para conocer el ID de cada módulo

$url = $baseUrl . '?' . http_build_query([
    'operation'   => 'describe',
    'sessionName' => $sessionId,
    'elementType' => 'Contacts',
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);
curl_close($ch); 
 curl "$BASE_URL\
  ?operation=describe\
  &sessionName=${SESSION}\
  &elementType=Contacts" 
 const params = new URLSearchParams({
  operation:   'describe',
  sessionName: sessionId,
  elementType: 'Contacts',
});
const res = await fetch(`${BASE_URL}?${params}`);
const { result } = await res.json();
// result.fields → campos del módulo
// result.idPrefix → ID del módulo 
 $url = $baseUrl . '?' . http_build_query([
    'operation'   => 'describe',
    'sessionName' => $sessionId,
    'elementType' => 'Contacts',
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
$fields = $data['result']['fields']; 
 curl -X POST "$BASE_URL" \
  -d "operation=create" \
  -d "sessionName=${SESSION}" \
  -d "elementType=Contacts" \
  --data-urlencode 'element={"firstname":"Juan","lastname":"García","email":"juan@ejemplo.com","assigned_user_id":"19x1"}' 
 const element = JSON.stringify({
  firstname:        'Juan',
  lastname:         'García',
  email:            'juan@ejemplo.com',
  assigned_user_id: '19x1',
});

const body = new URLSearchParams({
  operation:   'create',
  sessionName: sessionId,
  elementType: 'Contacts',
  element,
});

const res = await fetch(BASE_URL, { method: 'POST', body });
const { result } = await res.json();
const newId = result.id; // ej. "12x56789" 
 $element = json_encode([
    'firstname'        => 'Juan',
    'lastname'         => 'García',
    'email'            => 'juan@ejemplo.com',
    'assigned_user_id' => '19x1',
]);

$ch = curl_init($baseUrl);
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS     => http_build_query([
        'operation'   => 'create',
        'sessionName' => $sessionId,
        'elementType' => 'Contacts',
        'element'     => $element,
    ]),
]);
$data = json_decode(curl_exec($ch), true);
$newId = $data['result']['id'];
curl_close($ch); 
 curl "$BASE_URL\
  ?operation=retrieve\
  &sessionName=${SESSION}\
  &id=12x56789" 
 const params = new URLSearchParams({
  operation:   'retrieve',
  sessionName: sessionId,
  id:          '12x56789',
});
const res = await fetch(`${BASE_URL}?${params}`);
const { result } = await res.json();
// result contiene todos los campos del registro 
 $url = $baseUrl . '?' . http_build_query([
    'operation'   => 'retrieve',
    'sessionName' => $sessionId,
    'id'          => '12x56789',
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
$record = $data['result']; 
 # Incluye TODOS los campos del registro
curl -X POST "$BASE_URL" \
  -d "operation=update" \
  -d "sessionName=${SESSION}" \
  --data-urlencode 'element={"id":"12x56789","assigned_user_id":"19x1","firstname":"Juan","lastname":"García","email":"nuevo@ejemplo.com"}' 
 // Incluye TODOS los campos del registro
const element = JSON.stringify({
  id:               '12x56789',
  assigned_user_id: '19x1',
  firstname:        'Juan',
  lastname:         'García',
  email:            'nuevo@ejemplo.com',
});

const body = new URLSearchParams({
  operation:   'update',
  sessionName: sessionId,
  element,
});
const res = await fetch(BASE_URL, { method: 'POST', body }); 
 // Incluye TODOS los campos del registro
$element = json_encode([
    'id'               => '12x56789',
    'assigned_user_id' => '19x1',
    'firstname'        => 'Juan',
    'lastname'         => 'García',
    'email'            => 'nuevo@ejemplo.com',
]);

$ch = curl_init($baseUrl);
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS     => http_build_query([
        'operation'   => 'update',
        'sessionName' => $sessionId,
        'element'     => $element,
    ]),
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch); 
 # Solo los campos a modificar
curl -X POST "$BASE_URL" \
  -d "operation=revise" \
  -d "sessionName=${SESSION}" \
  --data-urlencode 'element={"id":"12x56789","email":"nuevo@ejemplo.com"}' 
 // Solo los campos a modificar (+ id obligatorio)
const element = JSON.stringify({
  id:    '12x56789',
  email: 'nuevo@ejemplo.com',
});

const body = new URLSearchParams({
  operation:   'revise',
  sessionName: sessionId,
  element,
});
const res = await fetch(BASE_URL, { method: 'POST', body }); 
 // Solo los campos a modificar (+ id obligatorio)
$element = json_encode([
    'id'    => '12x56789',
    'email' => 'nuevo@ejemplo.com',
]);

$ch = curl_init($baseUrl);
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS     => http_build_query([
        'operation'   => 'revise',
        'sessionName' => $sessionId,
        'element'     => $element,
    ]),
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch); 
 curl -X POST "$BASE_URL" \
  -d "operation=delete" \
  -d "sessionName=${SESSION}" \
  -d "id=12x56789" 
 const body = new URLSearchParams({
  operation:   'delete',
  sessionName: sessionId,
  id:          '12x56789',
});
const res = await fetch(BASE_URL, { method: 'POST', body });
const { success } = await res.json();
// success === true si el registro está en papelera 
 $ch = curl_init($baseUrl);
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS     => http_build_query([
        'operation'   => 'delete',
        'sessionName' => $sessionId,
        'id'          => '12x56789',
    ]),
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
// $data['success'] === true si OK 
 QUERY="SELECT * FROM Contacts WHERE lastname='García' LIMIT 10"
ENCODED=$(python3 -c "import urllib.parse,sys; print(urllib.parse.quote(sys.argv[1]))" "$QUERY")

curl "$BASE_URL\
  ?operation=query\
  &sessionName=${SESSION}\
  &query=${ENCODED}" 
 const query = "SELECT * FROM Contacts WHERE lastname = 'García' LIMIT 10";

const params = new URLSearchParams({
  operation:   'query',
  sessionName: sessionId,
  query,
});
const res = await fetch(`${BASE_URL}?${params}`);
const { result } = await res.json();
// result es array con los registros

// Paginación (máx 100 por petición):
const page2 = "SELECT * FROM Contacts LIMIT 100, 100"; 
 $query = "SELECT * FROM Contacts WHERE lastname = 'García' LIMIT 10";

$url = $baseUrl . '?' . http_build_query([
    'operation'   => 'query',
    'sessionName' => $sessionId,
    'query'       => $query,
]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);
$records = $data['result'];

// Paginación: "SELECT * FROM Contacts LIMIT 100, 100" 
 # Contacta con nuestro equipo:
# soporte@opencrm.es 
 // ¿Necesitas una operación personalizada?
// Escríbenos a soporte@opencrm.es 
 // ¿Necesitas una operación personalizada?
// Escríbenos a soporte@opencrm.es 