R7K12 — CRM API: referencia completa de métodos¶
URL base de todos los métodos: https://api.r7k12.com/{TOKEN}/<метод> (TOKEN es la clave de API de la cuenta).
addLeads (POST)¶
Método addLeads¶
Carga de información sobre negocios nuevos. Como respuesta se devuelve un array de identificadores de los negocios guardados y/o un array de identificadores de los negocios que no se han cargado, con la descripción del motivo. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/addLeads Parámetros: Tabla 1 Content-type: application/json Tabla 1
| Nombre | Valor | Obligatorio | Descripción |
| id | string | Sí | Identificador único del negocio en el sistema CRM |
| name | string | No | Nombre del negocio en el sistema CRM (no más de 500 caracteres). |
| dateCreate | unix time | Sí | Fecha de creación del negocio en formato UNIX |
| status | string | Sí | Identificador del estado del negocio en el sistema CRM. Para que los negocios se procesen correctamente, es necesario cargar los estados mediante el método setStatuses |
| dateChangeStatus | string | No | Fecha de cambio de estado en formato Y-m-d |
| type | string | No | Tipo de consulta (Form/Ringostat/Tilda, etc. ) |
| r7k12id | string | No | Identificador único de la visita (o fuente de la visita) de R7K12 |
| price | float | No | Importe del negocio |
| cost | float | No | Precio de coste del negocio |
| clientId | string | No | Identificador del cliente en el CRM |
| manager | string | No | Identificador del responsable a cargo del negocio |
| shop | string | No | Tienda a la que pertenece el negocio |
| appealUrl | string | No | URL completa de la página desde la que se realizó el pedido. Ejemplo: https://magazine.com/page1/product5/?c=1#block=1 |
| appeals | integer | No | Número de consultas del negocio |
| appealId | string | No | Identificador de la consulta obtenido con el método getAppeals |
| number | integer | No | Número de orden del negocio en el contacto |
| products | array[object] | No | Array de productos relacionados con el negocio (descripción en la Tabla 2). |
| payment | array[object] | No | Pagos del negocio (descripción en la Tabla 3) |
| fields | object | No | Campos adicionales del negocio |
Tabla 2
| Nombre | Valor | Obligatorio | Descripción |
| id | string | Sí | Identificador único del producto |
| name | string | Sí | Nombre del producto |
| price | float | Sí | Precio por unidad del producto |
| quantity | integer | Sí | Cantidad |
Tabla 3
| Nombre | Valor | Obligatorio | Descripción |
| id | string | Sí | Identificador único del pago |
| sum | float | Sí | Importe del pago |
| status | integer | Sí | Estado del pago (1 - pago realizado, -1 - pago cancelado) |
| date | string | Sí | Fecha de realización del pago. Formato AAAA-MM-DD |
Ejemplo del cuerpo de la petición:¶
[
{
"id":"1",
"name":"Сделка №1",
"dateCreate": 1508746231,
"status":"57667454",
"dateChangeStatus":"2017-10-21",
"type":"Form",
"r7k12id": "14154465",
"price":80.6,
"cost":70,
"clientId":"876",
"manager": 5,
"products": [
{
"id": "1",
"name": "Продукт 1",
"price": 0,
"quantity": 1
},
{
"id": "2",
"name": "Продукт 2",
"price": 124.6,
"quantity": 2
}
],
"payment": [
{
"id": "6458erg",
"sum": 50,
"status": 1,
"date": "2018-04-16"
},
{
"id": "jf94ksm",
"sum": 100,
"status": 1,
"date": "2018-04-20"
}
],
"fields": {
"1": "fields 1",
"45": "fields 3"
}
},
{
"id":"2",
"name":"Сделка №2",
"dateCreate": 1508746531,
"status":"7454",
"r7k12id": "site_offline"
},
{
"id":"3",
"name":"Сделка №3",
"dateCreate": 1509746531,
"status":"744"
}
]
Ejemplo de respuesta:
{
"upload" : [1,2,3],
"notUpload" : [
{
"id" : 4,
"message" : "Не указан параметр 'dateСreate'"
},
{
"id" : 5,
"message" : "Сделка с указанным идентификатором уже существует"
},
{
"id" : 6,
"message" : "Не удалось загрузить сделку. Указана некорректная дата создания сделки"
}
]
}
Ejemplo de script (PHP):
define('TOKEN','XXXXXXXXX');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/addLeads',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
[
'id' => '1',
'name' => 'Сделка №1',
'dateCreate' => 1508746231,
'status' => '57667454',
'type' => 'Form',
'r7k12id' => '14154465',
'price' => 80.6,
'cost' => 70,
'clientId' => '876',
'manager' => '5',
'shop' => 'магазин',
'products' => [
[
'id' => '1',
'name' => 'Продукт 1',
'price' => 0,
'quantity' => 1
],
[
'id' => '2',
'name' => 'Продукт 2',
'price' => 124.6,
'quantity' => 2
]
],
'fields' => [
'1' => 'fields 1',
'45' => 'fields 3'
]
],
[
'id' => '2',
'name' => 'Сделка №2',
'dateCreate' => 1508746531,
'status' => '7454',
'r7k12id' => 'site_offline',
],
[
'id' => '3',
'name' => 'Сделка №3',
'dateCreate' => 1509746531,
'status' => '744',
]
]
)
]
]
)
);
getLeads (GET)¶
Método getLeads¶
getLeads¶
El método permite obtener la lista de negocios, incluidos los que se crearon a través del servicio R7K12. El método devuelve como máximo 10000 registros por llamada; en la respuesta a cada petición se añade el parámetro «totalResult» con el número total de resultados. Método: GET Enlace: https://api.r7k12.com/{{TOKEN}}/getLeads Parámetros: Tabla 1 Tabla 1
| Parámetro | Tipo | Obligatorio | Descripción |
| id | string | No | Identificador único del negocio en el CRM. Si se utiliza este parámetro, la respuesta contendrá el negocio con el identificador indicado (si existe). |
| lastModified | string | No | Fecha de la última modificación del negocio. Formato: - AAAA-MM-DD HH:MM:SS - AAAA-MM-DD. Si se indica este parámetro, en la respuesta solo se mostrarán los negocios que se modificaron/crearon después de la fecha indicada. |
| fields | array [string] | No | Lista de campos que deben mostrarse en la respuesta. Si no se especifica el parámetro, solo se muestran los identificadores. Campos disponibles: - id - identificador del negocio - r7k12id - identificador de la «visita» - name - nombre del negocio - status - estado del negocio - type - tipo de consulta - dateCreate - fecha de creación (UNIX) - lastModified - fecha de modificación - price - importe del negocio - cost - precio de coste del negocio - clientId - identificador del cliente del CRM - manager - identificador del responsable a cargo del negocio - products - array de productos - fields - campos adicionales del negocio |
| limit | integer | No | Número de registros que se muestran en el resultado (por defecto «10000») |
| page | integer | No | Número de la página que se muestra (por defecto «1») |
Ejemplo de petición:
define('TOKEN','XXXXXXXXX');
$data = @file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/getLeads?'.
http_build_query(
[
'lastModified' => '2017-11-11',
'fields' => [
'id',
'status',
'price',
'cost',
'fields'
],
'limit'=> 1
]
)
);
Respuesta:
{
"page" : 1,
"totalResult": 156,
"data": [
{
"id" : "1",
"status" : "587",
"price" : 0,
"cost" : 0,
"fields" : {
"source1" : "yandex",
"source2" : "organic",
"source3" : "(not set)"
}
}
]
}
updateLeads (POST)¶
Método updateLeads¶
Actualización de la información de negocios existentes. Permite actualizar cualquier parámetro del negocio (excepto el identificador). Como respuesta se devuelve un array de identificadores de los negocios actualizados y/o un array de identificadores de los negocios que no se han actualizado, con la descripción del motivo. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/updateLeads Parámetros: Tabla 1 Content-type: application/json Tabla 1
| Nombre | Valor | Obligatorio | Descripción |
| id | string | Sí | Identificador único del negocio que se actualiza en el sistema CRM |
| name | string | No | Nombre del negocio en el sistema CRM (no más de 500 caracteres). |
| status | string | No | Identificador del estado del negocio en el sistema CRM. |
| dateChangeStatus | string | No | Fecha de cambio de estado en formato Y-m-d |
| type | string | No | Tipo de consulta (Form/Ringostat/Tilda, etc. ) |
| type | string | No | Tipo de consulta (Form/Ringostat/Tilda, etc. ) |
| price | float | No | Importe del negocio |
| cost | float | No | Precio de coste del negocio |
| clientId | string | No | Identificador del cliente en el CRM |
| manager | string | No | Identificador del responsable a cargo del negocio |
| shop | string | No | Tienda a la que pertenece el negocio |
| appealUrl | string | No | URL completa de la página desde la que se realizó el pedido. Ejemplo: https://magazine.com/page1/product5/?c=1#block=1 |
| appeals | integer | No | Número de consultas del negocio |
| appealId | string | No | Identificador de la consulta obtenido con el método getAppeals |
| number | integer | No | Número de orden del negocio en el contacto |
| products | array[object] | No | Array de productos relacionados con el negocio (descripción en la Tabla 2). |
| payment | array[object] | No | Pagos del negocio (descripción en la Tabla 3) |
| fields | object | No | Campos adicionales del negocio. Nota: si se envía el parámetro «fields», se sobrescribe por completo |
Tabla 2
| Nombre | Valor | Obligatorio | Descripción |
| id | string | Sí | Identificador único del producto |
| name | string | Sí | Nombre del producto |
| price | float | Sí | Precio por unidad del producto |
| quantity | integer | Sí | Cantidad |
Tabla 3
| Nombre | Valor | Obligatorio | Descripción |
| id | string | Sí | Identificador único del pago |
| sum | float | Sí | Importe del pago |
| status | integer | Sí | Estado del pago (1 - pago realizado, -1 - pago cancelado) |
| date | string | Sí | Fecha de realización del pago. Formato AAAA-MM-DD |
Ejemplo del cuerpo de la petición:¶
[
{
"id":"1",
"name":"Сделка закрыта"//Обновить название сделки
"status":"100"//Обновить статус сделки
},
{
"id":"2",
"price":7454//Обновить сумму сделки
},
{
"id":"3",
"products": [//Обновить список продуктов
{
"id": "1",
"name": "Продукт 1",
"price": 0,
"quantity": 1
},
{
"id": "2",
"name": "Продукт 2",
"price": 124.6,
"quantity": 2
}
]
}
]
Ejemplo de respuesta:¶
{
"update" : [1,2,3],
"notUpdate" : [
{
"id" : NULL,
"message" : "Не указан идентификатор сделки"
},
{
"id" : 5,
"message" : "Сделка с указанным идентификатором не существует"
}
]
}
Ejemplo de script (PHP):¶
define('TOKEN','XXXXXXXXX');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/updateLeads',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
[
'id' => '1',
'name' => 'Сделка закрыта',
'status' => '100'
],
[
'id' => '2',
'price' => 7454
],
[
'id' => '3',
'products' => [
[
'id' => '1',
'name' => 'Продукт 1',
'price' => 0,
'quantity' => 1
],
[
'id' => '2',
'name' => 'Продукт 2',
'price' => 124.6,
'quantity' => 2
]
]
]
]
)
]
]
)
);
deleteLeads (POST)¶
Método deleteLeads¶
deleteLeads¶
El método permite eliminar negocios. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/deleteLeads Parámetros: Tabla 1 Content-type: application/json Tabla 1
| Nombre | Valor | Obligatorio | Descripción |
| ids | array[string] | Sí | Array de identificadores únicos de los negocios que se deben eliminar |
Ejemplo del cuerpo de la petición:
{
"ids" : [1,2,3]
}
Ejemplo de script (PHP):
define('TOKEN','XXXXXXXXX');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/deleteLeads',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
'ids' => [1, 2, 3]
]
)
]
]
)
);
addContacts (POST)¶
Método addContacts¶
addContacts¶
Carga de información sobre contactos nuevos. Como respuesta se devuelve un array de identificadores de los contactos guardados y/o un array de identificadores de los contactos que no se han cargado, con la descripción del motivo. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/addContacts Parámetros: Tabla 1 Content-type: application/json
| Parámetro | Tipo | Obligatorio | Descripción |
| id | string | Sí | Identificador único del contacto en el CRM. |
| name | string | No | Nombre del contacto |
| dateCreate | double (UNIX) | Sí | Fecha de creación del contacto |
| phone | array [string] | No (si hay e-mail) | Array de números de teléfono del contacto |
| array [string] | No (si hay phone) | Array de direcciones de e-mail del contacto | |
| leads | array [string] | No | Array de identificadores de los negocios a los que pertenece este contacto. |
Ejemplo del cuerpo de la petición:
[
{
"name": "Контакт 1",
"id": "1",
"dateCreate": 1497800760,
"phone": [
"380441234567",
"380443215476"
],
"email": [
"[email protected]",
"[email protected]"
],
"leads": [
"150",
"6583"
]
},
{
"name": "Контакт 2",
"id": "2",
"dateCreate": 1497800760,
"phone": [
"380441234568"
]
},
{
"name": "Контакт 3",
"id": "3",
"dateCreate": 1497800760,
"email": [
"[email protected]"
],
"leads": [
"67889"
]
}
]
Ejemplo de respuesta:
{
"upload" : [1,2,3],
"notUpload" : [
{
"id" : 4,
"message" : "Не указан параметр 'dateСreate'"
},
{
"id" : 5,
"message" : "Контакт с указанным идентификатором уже существует"
}
]
}
Ejemplo de script (PHP):
define('TOKEN','XXXXXXXXX');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/addContacts',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
[
'name' => 'Контакт 1',
'id' => '1',
'dateCreate' => 1497800760,
'phone' => [
'380441234567',
'380443215476'
],
'email' => [
'[email protected]',
'[email protected]'
],
'leads' => [
'150',
'6583'
]
],
[
'name' => 'Контакт 2',
'id' => '2',
'dateCreate' => 1497800760,
'phone' => [
'380441234568'
]
],
[
'name' => 'Контакт 3',
'id' => '3',
'dateCreate' => 1497800760,
'email' => [
'[email protected]'
],
'leads' => [
'67889'
]
]
]
)
]
]
)
);
getContacts (GET)¶
Método getContacts¶
getContacts¶
El método permite obtener la lista de contactos, incluidos los que se crearon a través del servicio R7K12. El método devuelve como máximo 10000 registros por llamada; en la respuesta a cada petición se añade el parámetro «totalResult» con el número total de resultados. Método: GET Enlace: https://api.r7k12.com/{{TOKEN}}/getContacts Parámetros: Tabla 1 Tabla 1
| Parámetro | Tipo | Obligatorio | Descripción |
| id | string | No | Identificador único del contacto en el CRM. Si se utiliza este parámetro, la respuesta contendrá el contacto con el identificador indicado (si existe). |
| lastModified | string | No | Fecha de la última modificación del contacto. Formato: - AAAA-MM-DD HH:MM:SS - AAAA-MM-DD. Si se indica este parámetro, en la respuesta solo se mostrarán los contactos que se modificaron/crearon después de la fecha indicada. |
| fields | array [string] | No | Lista de campos que deben mostrarse en la respuesta. Si no se especifica el parámetro, solo se muestran los identificadores. Campos disponibles: - id - identificador del contacto - name - nombre del contacto - phone - array de números de teléfono - email - array de direcciones de email - leads - array de identificadores de negocios - dateCreate - fecha de creación (UNIX) - lastModified - fecha de modificación (UNIX) |
| limit | integer | No | Número de registros que se muestran en el resultado (por defecto «10000») |
| page | integer | No | Número de la página que se muestra (por defecto «1») |
Ejemplo de petición:
define('TOKEN','XXXXXXXXX');
$data = @file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/getContacts?'.
http_build_query(
[
'fields' => [
'id',
'phone',
'leads'
],
'limit' => 1
]
)
);
Respuesta:
{
"page" : 1,
"totalResult": 100,
"data": [
{
"id" : "43",
"phone" : [
"380441234567",
"380503215476"
],
"leads" : [
"1"
]
}
]
}
updateContacts (POST)¶
Método updateContacts¶
updateContacts¶
Actualización de la información de contactos existentes. Permite actualizar cualquier parámetro del contacto (excepto el identificador). Como respuesta se devuelve un array de identificadores de los contactos actualizados y/o un array de identificadores de los contactos que no se han actualizado, con la descripción del motivo. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/updateContacts Parámetros: Tabla 1 Content-type: application/json Tabla 1
| Parámetro | Tipo | Obligatorio | Descripción |
| id | string | Sí | Identificador único del contacto en el CRM. |
| name | string | No | Nombre del contacto |
| phone | array [string] | No | Array de números de teléfono nuevos del contacto que se deben añadir |
| array [string] | No | Array de direcciones de e-mail del contacto que se deben añadir | |
| leads | array [string] | No | Array de identificadores de los negocios a los que pertenece este contacto que se deben añadir |
Ejemplo del cuerpo de la petición:
[
{
"name": "Name update",
"id": "1"
},
{
"id": "2",
"phone": [
"380441234560"
]
},
{
"id": "3",
"email": [
"[email protected]"
],
"leads": [
"679"
]
}
]
Ejemplo de respuesta:
{
"upload" : [1,2,3],
"notUpdate" : [,
{
"id" : 5,
"message" : "Контакт с указанным идентификатором не существует"
}
]
}
Ejemplo de script (PHP):
define('TOKEN','XXXXXXXXX');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/updateContacts',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
[
'name' => 'Name update',
'id' => '1'
],
[
'id' => '2',
'phone' => [
'380441234560'
]
],
[
'id' => '3',
'email' => [
'[email protected]'
],
'leads' => [
'679'
]
]
]
)
]
]
)
);
deleteContacts (POST)¶
Método deleteContacts¶
deleteContacts¶
El método permite eliminar negocios. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/deleteContacts Parámetros: Tabla 1 Content-type: application/json Tabla 1
| Nombre | Valor | Obligatorio | Descripción |
| ids | array[string] | Sí | Array de identificadores únicos de los contactos que se deben eliminar |
Ejemplo del cuerpo de la petición:
{
"ids" : [1,2,3]
}
Ejemplo de script (PHP):
define('TOKEN','XXXXXXXXX');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/deleteContacts',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
'ids' => [1, 2, 3]
]
)
]
]
)
);
setStatuses (POST)¶
Método setStatuses¶
Carga de los estados de los negocios. Si se envía un estado con un ID ya registrado en el servicio R7K12, el estado se actualizará. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/setStatuses Parámetros: Tabla 1 Content-type: application/json Tabla 1
| Nombre | Valor | Obligatorio | Descripción |
| id | string | Sí | Identificador único del estado en el sistema CRM |
| group | integer | Sí | Grupo al que pertenece el estado. Valor de 1 a 4. - 1 - No contabilizado - 2 - En curso - 3 - Completado - 4 - Cancelado |
| name | string | No | Nombre del estado en el sistema CRM (no más de 500 caracteres). |
Ejemplo del cuerpo de la petición:¶
[
{
"id":"56385",
"group":"1",//Не учитывать
"name":"Новый заказ"
},
{
"id":"57667454",
"group":"3"//Успешно реализовано
}
]
Ejemplo de script (PHP):¶
define('TOKEN','YOURTOKEN');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/setStatuses',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
[
'id' => '56385',
'group' => '1',
'name' => 'Новый заказ'
],
[
'id' => '57667454',
'group' => '3'
],
]
),
],
]
)
);
setManagers (POST)¶
Método setManagers¶
El método permite cargar la lista de responsables del sistema CRM. Si se envía un responsable con un ID ya registrado en el servicio R7K12, el nombre del responsable se actualizará. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/setManagers Parámetros: Tabla 1 Content-type: application/json Tabla 1
| Nombre | Valor | Obligatorio | Descripción |
| id | string | Sí | Identificador único del responsable en el sistema CRM |
| name | string | Sí | Nombre del responsable |
Ejemplo del cuerpo de la petición:¶
[
{
"id":"1",
"name":"Менеджер №1"
},
{
"id":"2",
"name":"Менеджер №2"
}
]
Ejemplo de script (PHP):¶
define('TOKEN','YOURTOKEN');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/setManagers',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
[
'id' => '1',
'name' => 'Менеджер №1'
],
[
'id' => '2',
'name' => 'Менеджер №2'
],
]
),
],
]
)
);
getAppeals (GET)¶
Método getAppeals¶
getAppeals¶
El método permite obtener la lista de consultas que han llegado al servicio R7K12. El método devuelve como máximo 10000 registros por llamada; en la respuesta a cada petición se añade el parámetro «totalResult» con el número total de resultados. Método: GET Enlace: https://api.r7k12.com/{{TOKEN}}/getAppeals Parámetros: Tabla 1 Tabla 1
| Parámetro | Tipo | Obligatorio | Descripción |
| date | string | No | Fecha de entrada de la consulta en el sistema. Formato: - AAAA-MM-DD HH:MM:SS - AAAA-MM-DD. Si se indica este parámetro, en la respuesta solo se mostrarán las consultas que se crearon después de la fecha indicada. |
| phone | string | No | Número de teléfono indicado en la consulta. Debe constar solo de dígitos. Si se indica, solo se mostrarán las consultas cuyo número de teléfono coincida con el número especificado. |
| string | No | Dirección de correo electrónico indicada en la consulta. Debe ser una dirección de correo electrónico válida. Si se indica, solo se mostrarán las consultas cuyo número de teléfono coincida con el email especificado. | |
| fields | array [string] | No | Lista de campos que deben mostrarse en la respuesta. Si no se especifica el parámetro, solo se muestran los identificadores de sesión (r7k12id). Campos disponibles: - id - identificador de la consulta - r7k12id - identificador de la sesión - name - nombre indicado en la consulta - phone - número de teléfono - email - dirección de email - comment - comentario - date - fecha de creación (UNIX) - type - tipo de consulta - call_duration - duración de la llamada - call_record - enlace a la grabación de la conversación - call_status - estado de la llamada - price - precio del negocio - href - enlace a la página desde la que se envió la solicitud - raw_data - datos de la solicitud tal como llegaron |
| limit | integer | No | Número de registros que se muestran en el resultado (por defecto «10000») |
| page | integer | No | Número de la página que se muestra (por defecto «1») |
Ejemplo de petición:
define('TOKEN','XXXXXXXXX');
$data = @file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/getAppeals?'.
http_build_query(
[
'fields' => [
'r7k12id',
'name',
'phone',
'email'
],
'limit' => 1
]
)
);
Ответ:
{
"page" : 1,
"totalResult": 100,
"data": [
{
"r7k12id" : "4239487948343",
"name" : "Contact’s Name",
"phone" : "380441234567",
"email" : "[email protected]"
}
]
}
updateIdsEssenceCrm (POST)¶
Método updateIdsEssenceCrm¶
updateIdsEssenceCrm¶
El método permite actualizar el identificador único de una entidad (contacto/negocio) del CRM. Este método es adecuado en el caso de la integración «CRM propio» y al utilizar el módulo de envío de datos, cuando es necesario sustituir el identificador de entidad del CRM asignado por el servicio R7K12 por uno propio. Método: POST Formato: JSON Enlace: https://api.r7k12.com/{{TOKEN}}/updateIdsEssenceCrm Parámetros: Tabla 1 Content-type: application/json Tabla 1
| Nombre | Valor | Obligatorio | Descripción |
| type | ENUM (‘lead’, ’contact’) | Sí | Tipo de entidad del CRM cuyo identificador se debe cambiar |
| oldId | string | Sí | Identificador de la entidad establecido actualmente. |
| newId | string | Sí | Identificador de la entidad que se debe establecer. |
Ejemplo del cuerpo de la petición:
[
{
"type":"lead",
"oldId":"jf97gaossz",
"newId":"301cb030-4126-4065-94d9-8dc2a345573d"
},
{
"type":"lead",
"oldId":"6y62zhzifs",
"newId":"2ed7874b-3646-499b-a54e-ccd31a843527"
},
{
"type":"contact",
"oldId":"3reuqfl2di",
"newId":"f77b6a3f-aab3-4a80-b752-cdfe15ae31b2"
}
]
Ejemplo de respuesta:
[
{
"type":"lead",
"id":"jf97gaossz",//oldId
"status":"success"
},
{
"type":"lead",
"id":"6y62zhzifs",
"status":"error",
"error_message":"Новый идентификатор не является уникальным"
},
{
"type":"contact",
"id":"3reuqfl2di",
"status":"success"
}
]
Ejemplo de script (PHP):
define('TOKEN','XXXXXXXXX');
@file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/updateIdsEssenceCrm',
0,
stream_context_create(
[
'http' => [
'method' => "POST",
'header' => "Content-Type: application/json\r\n",
'content' => json_encode(
[
[
'type' => 'lead',
'oldId' => 'jf97gaossz',
'newId' => '301cb030-4126-4065-94d9-8dc2a345573d'
],
[
'type' => 'lead',
'oldId' => '6y62zhzifs',
'newId' => '2ed7874b-3646-499b-a54e-ccd31a843527'
],
[
'type' => 'contact',
'oldId' => '3reuqfl2di',
'newId' => 'f77b6a3f-aab3-4a80-b752-cdfe15ae31b2'
]
]
)
]
]
)
);
setShippingTrackingId (POST)¶
Método setShippingTrackingId¶
El método permite añadir o actualizar el número de seguimiento del envío postal en el negocio. Al indicar el número de guía electrónica, el servicio de entrega debe estar conectado en las integraciones de R7K12CRM. Cantidad máxima de datos de entrada: 100. Método: POST Enlace: https://api.r7k12.com/{{TOKEN}}/R7K12Crm Parámetros: Tabla n.º 1 Datos de entrada:
{
"method": "setShippingTrackingId",
"input": [
{
"dealId": (string),
"type": (string),
"shippingId": (string)
},
...
]
}
Tabla n.º 1
| Parámetro | Tipo | Obligatorio | Descripción |
| method | string | Sí | Método invocado. Siempre «setShippingTrackingId» |
| input | array[object] | Sí | Parámetros de entrada del método |
| input[index].dealId | string | Sí | Identificador del negocio |
| input[index].type | string | Sí | Identificador del servicio de entrega al que pertenece el número de seguimiento - «novaPoshta» - Nova Poshta |
| input[index].shippingId | string | Sí | Número de seguimiento del envío postal |
Ejemplo de petición:
define('TOKEN','YOURTOKEN');
function POST ($request) {
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://api.r7k12.com/'.TOKEN.'/R7K12Crm');
curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($request,JSON_UNESCAPED_UNICODE));
$out = curl_exec($curl);
curl_close($curl);
return json_decode($out,true);
}
$response = POST(
[
'method' => 'setShippingTrackingId' ,
'input' => [
[
'dealId' => '5e450c947e7c21254b42a942',
'fields' => 'novaPoshta',
'fields' => '1234567890',
]
]
]
);
print_r($response);
Procesamiento de la respuesta:
{
"success": true,
"warning": [
{
"dealId": (string),
"type": (syting),
"shippingId": (string),
"error": (string)
}
]
}
Tabla n.º 2
| Parámetro | Tipo | Obligatorio | Descripción |
| success | true | No | Indicador de procesamiento correcto de todos los datos cargados. Solo está presente si todos los datos se procesaron correctamente |
| warning | array[object] | No | Array de datos de entrada no procesados |
| warning[index].dealId | string | Sí | Identificador del negocio |
| warning[index].type | string | Sí | Identificador del servicio de entrega al que pertenece el número de seguimiento - «novaPoshta» - Nova Poshta |
| warning[index].shippingId | string | Sí | Número de seguimiento del envío postal |
| warning[index].error | string | Sí | Motivo por el que no se procesaron los datos: - Field "dealId": must be string (a-z0-9) - Deal not found - Incorrect field "shippingId" - Incorrect shipping system - The electronic invoice number "XXXXX" is already set on another deal - Shipping system is not enabled |
Errores de la API¶
Formato de la respuesta:
{
"error": {
"code": (int),
"error": (string),
"error_detail": (string)
}
}
Tabla n.º 3
| Código | Error | Descripción |
| -1 | No se ha podido ejecutar la petición | Se ha producido un error interno de la API. Póngase en contacto con el soporte técnico indicando el requestId |
| 20 | Clave de acceso incorrecta | |
| 21 | Método incorrecto | |
| 22 | Formato de datos incorrecto | |
| 23 | No se han indicado los parámetros obligatorios | |
| 24 | La integración con la API no está conectada | |
| 25 | Error de escritura | |
| 26 | El número máximo de registros por petición es 100 | |
| 27 | El intervalo entre peticiones debe ser de al menos 3 segundos | |
| 28 | No hay acceso al proyecto seleccionado | |
| 29 | Permisos insuficientes para ejecutar este método | |
| 210 | Para ejecutar el método seleccionado se necesita la clave de acceso del usuario | Es necesario obtener la clave mediante el esquema OAUTH2 |
| 211 | El token de acceso está bloqueado | Para obtener más información, póngase en contacto con el soporte técnico |
| 212 | No es posible ejecutar en paralelo peticiones con los mismos métodos | El método de la API seleccionado ya se está utilizando en una petición paralela con el token indicado |
| 301 | Invalid API Method | Se ha invocado un método incorrecto de la API de R7K12 CRM |
| 302 | R7K12 CRM is not connected in the project | R7K12 CRM no está conectado en el proyecto |
| 303 | Integration not connected in R7K12 CRM | La integración no está conectada dentro de R7K12 CRM |
| 304 | Incorrect input data | Datos de entrada incorrectos |
| 305 | A lot of data | Se ha superado la cantidad máxima de datos de entrada |