R7K12 — CRM API: pełna dokumentacja metod¶
Bazowy URL wszystkich metod: https://api.r7k12.com/{TOKEN}/<метод> (TOKEN — klucz API konta).
addLeads (POST)¶
Metoda addLeads¶
Przesyłanie informacji o nowych transakcjach. W odpowiedzi zwracana jest tablica identyfikatorów zapisanych transakcji i/lub tablica identyfikatorów transakcji, które nie zostały przesłane, wraz z opisem przyczyny. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/addLeads Parametry: Tabela 1 Content-type: application/json Tabela 1
| Nazwa | Wartość | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator transakcji w systemie CRM |
| name | string | Nie | Nazwa transakcji w systemie CRM (nie więcej niż 500 znaków). |
| dateCreate | unix time | Tak | Data utworzenia transakcji w formacie UNIX |
| status | string | Tak | Identyfikator statusu transakcji w systemie CRM. Aby transakcje były poprawnie przetwarzane, należy przesłać statusy za pomocą metody setStatuses |
| dateChangeStatus | string | Nie | Data zmiany statusu w formacie Y-m-d |
| type | string | Nie | Typ zapytania (Form/Ringostat/Tilda itp. ) |
| r7k12id | string | Nie | Unikalny identyfikator wizyty (lub źródło wizyty) R7K12 |
| price | float | Nie | Kwota transakcji |
| cost | float | Nie | Koszt własny transakcji |
| clientId | string | Nie | Identyfikator klienta w CRM |
| manager | string | Nie | Identyfikator menedżera odpowiedzialnego za transakcję |
| shop | string | Nie | Sklep, którego dotyczy transakcja |
| appealUrl | string | Nie | Pełny URL strony, z której złożono zamówienie. Przykład: https://magazine.com/page1/product5/?c=1#block=1 |
| appeals | integer | Nie | Liczba zapytań w ramach transakcji |
| appealId | string | Nie | Identyfikator zapytania uzyskany metodą getAppeals |
| number | integer | Nie | Numer kolejny transakcji kontaktu |
| products | array[object] | Nie | Tablica produktów powiązanych z transakcją (opis: Tabela 2). |
| payment | array[object] | Nie | Płatności w ramach transakcji (opis: Tabela 3) |
| fields | object | Nie | Dodatkowe pola transakcji |
Tabela 2
| Nazwa | Wartość | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator produktu |
| name | string | Tak | Nazwa produktu |
| price | float | Tak | Cena za jednostkę produktu |
| quantity | integer | Tak | Ilość |
Tabela 3
| Nazwa | Wartość | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator płatności |
| sum | float | Tak | Kwota płatności |
| status | integer | Tak | Status płatności (1 - płatność dokonana, -1 - płatność anulowana) |
| date | string | Tak | Data dokonania płatności. Format RRRR-MM-DD |
Przykład treści żądania:¶
[
{
"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"
}
]
Przykład odpowiedzi:
{
"upload" : [1,2,3],
"notUpload" : [
{
"id" : 4,
"message" : "Не указан параметр 'dateСreate'"
},
{
"id" : 5,
"message" : "Сделка с указанным идентификатором уже существует"
},
{
"id" : 6,
"message" : "Не удалось загрузить сделку. Указана некорректная дата создания сделки"
}
]
}
Przykład skryptu (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)¶
Metoda getLeads¶
getLeads¶
Metoda pozwala pobrać listę transakcji, w tym tych, które zostały utworzone przez serwis R7K12. Metoda zwraca nie więcej niż 10000 rekordów w jednym wywołaniu, a do odpowiedzi na każde żądanie dodawany jest parametr „totalResult” - z łączną liczbą wyników. Metoda: GET Link: https://api.r7k12.com/{{TOKEN}}/getLeads Parametry: Tabela 1 Tabela 1
| Parametr | Typ | Wymagany | Opis |
| id | string | Nie | Unikalny identyfikator transakcji w CRM. Przy użyciu tego parametru odpowiedź będzie zawierać transakcję o podanym identyfikatorze (jeśli taka istnieje). |
| lastModified | string | Nie | Data ostatniej zmiany transakcji. Format: - RRRR-MM-DD GG:MM:SS - RRRR-MM-DD. Jeśli podano ten parametr, w odpowiedzi zostaną zwrócone tylko te transakcje, które zostały zmienione/utworzone po podanej dacie. |
| fields | array [string] | Nie | Lista pól, które mają zostać zwrócone w odpowiedzi. Jeśli parametr nie jest ustawiony, zwracane są tylko identyfikatory. Dostępne pola: - id - identyfikator transakcji - r7k12id - identyfikator „wizyty” - name - nazwa transakcji - status - status transakcji - type - typ zapytania - dateCreate - data utworzenia (UNIX) - lastModified - data zmiany - price - kwota transakcji - cost - koszt własny transakcji - clientId - identyfikator klienta CRM - manager - identyfikator menedżera odpowiedzialnego za transakcję - products - tablica produktów - fields - dodatkowe pola transakcji |
| limit | integer | Nie | Liczba rekordów zwracanych w wyniku (domyślnie „10000”) |
| page | integer | Nie | Numer zwracanej strony (domyślnie „1”) |
Przykład żądania:
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
]
)
);
Odpowiedź:
{
"page" : 1,
"totalResult": 156,
"data": [
{
"id" : "1",
"status" : "587",
"price" : 0,
"cost" : 0,
"fields" : {
"source1" : "yandex",
"source2" : "organic",
"source3" : "(not set)"
}
}
]
}
updateLeads (POST)¶
Metoda updateLeads¶
Aktualizacja informacji o istniejących transakcjach. Pozwala zaktualizować dowolny parametr transakcji (oprócz identyfikatora). W odpowiedzi zwracana jest tablica identyfikatorów zaktualizowanych transakcji i/lub tablica identyfikatorów transakcji, które nie zostały zaktualizowane, wraz z opisem przyczyny. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/updateLeads Parametry: Tabela 1 Content-type: application/json Tabela 1
| Nazwa | Wartość | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator aktualizowanej transakcji w systemie CRM |
| name | string | Nie | Nazwa transakcji w systemie CRM (nie więcej niż 500 znaków). |
| status | string | Nie | Identyfikator statusu transakcji w systemie CRM. |
| dateChangeStatus | string | Nie | Data zmiany statusu w formacie Y-m-d |
| type | string | Nie | Typ zapytania (Form/Ringostat/Tilda itp. ) |
| type | string | Nie | Typ zapytania (Form/Ringostat/Tilda itp. ) |
| price | float | Nie | Kwota transakcji |
| cost | float | Nie | Koszt własny transakcji |
| clientId | string | Nie | Identyfikator klienta w CRM |
| manager | string | Nie | Identyfikator menedżera odpowiedzialnego za transakcję |
| shop | string | Nie | Sklep, którego dotyczy transakcja |
| appealUrl | string | Nie | Pełny URL strony, z której złożono zamówienie. Przykład: https://magazine.com/page1/product5/?c=1#block=1 |
| appeals | integer | Nie | Liczba zapytań w ramach transakcji |
| appealId | string | Nie | Identyfikator zapytania uzyskany metodą getAppeals |
| number | integer | Nie | Numer kolejny transakcji kontaktu |
| products | array[object] | Nie | Tablica produktów powiązanych z transakcją (opis: Tabela 2). |
| payment | array[object] | Nie | Płatności w ramach transakcji (opis: Tabela 3) |
| fields | object | Nie | Dodatkowe pola transakcji. Uwaga: w przypadku przesłania parametru „fields” jest on nadpisywany w całości |
Tabela 2
| Nazwa | Wartość | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator produktu |
| name | string | Tak | Nazwa produktu |
| price | float | Tak | Cena za jednostkę produktu |
| quantity | integer | Tak | Ilość |
Tabela 3
| Nazwa | Wartość | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator płatności |
| sum | float | Tak | Kwota płatności |
| status | integer | Tak | Status płatności (1 - płatność dokonana, -1 - płatność anulowana) |
| date | string | Tak | Data dokonania płatności. Format RRRR-MM-DD |
Przykład treści żądania:¶
[
{
"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
}
]
}
]
Przykład odpowiedzi:¶
{
"update" : [1,2,3],
"notUpdate" : [
{
"id" : NULL,
"message" : "Не указан идентификатор сделки"
},
{
"id" : 5,
"message" : "Сделка с указанным идентификатором не существует"
}
]
}
Przykład skryptu (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)¶
Metoda deleteLeads¶
deleteLeads¶
Metoda pozwala usunąć transakcje. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/deleteLeads Parametry: Tabela 1 Content-type: application/json Tabela 1
| Nazwa | Wartość | Wymagany | Opis |
| ids | array[string] | Tak | Tablica unikalnych identyfikatorów transakcji, które należy usunąć |
Przykład treści żądania:
{
"ids" : [1,2,3]
}
Przykład skryptu (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)¶
Metoda addContacts¶
addContacts¶
Przesyłanie informacji o nowych kontaktach. W odpowiedzi zwracana jest tablica identyfikatorów zapisanych kontaktów i/lub tablica identyfikatorów kontaktów, które nie zostały przesłane, wraz z opisem przyczyny. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/addContacts Parametry: Tabela 1 Content-type: application/json
| Parametr | Typ | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator kontaktu w CRM. |
| name | string | Nie | Nazwa kontaktu |
| dateCreate | double (UNIX) | Tak | Data utworzenia kontaktu |
| phone | array [string] | Nie (jeśli podano e-mail) | Tablica numerów telefonów kontaktu |
| array [string] | Nie (jeśli podano phone) | Tablica adresów e-mail kontaktu | |
| leads | array [string] | Nie | Tablica identyfikatorów transakcji, z którymi powiązany jest ten kontakt. |
Przykład treści żądania:
[
{
"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"
]
}
]
Przykład odpowiedzi:
{
"upload" : [1,2,3],
"notUpload" : [
{
"id" : 4,
"message" : "Не указан параметр 'dateСreate'"
},
{
"id" : 5,
"message" : "Контакт с указанным идентификатором уже существует"
}
]
}
Przykład skryptu (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)¶
Metoda getContacts¶
getContacts¶
Metoda pozwala pobrać listę kontaktów, w tym tych, które zostały utworzone przez serwis R7K12. Metoda zwraca nie więcej niż 10000 rekordów w jednym wywołaniu, a do odpowiedzi na każde żądanie dodawany jest parametr „totalResult” - z łączną liczbą wyników. Metoda: GET Link: https://api.r7k12.com/{{TOKEN}}/getContacts Parametry: Tabela 1 Tabela 1
| Parametr | Typ | Wymagany | Opis |
| id | string | Nie | Unikalny identyfikator kontaktu w CRM. Przy użyciu tego parametru odpowiedź będzie zawierać kontakt o podanym identyfikatorze (jeśli taki istnieje). |
| lastModified | string | Nie | Data ostatniej zmiany kontaktu. Format: - RRRR-MM-DD GG:MM:SS - RRRR-MM-DD. Jeśli podano ten parametr, w odpowiedzi zostaną zwrócone tylko te kontakty, które zostały zmienione/utworzone po podanej dacie. |
| fields | array [string] | Nie | Lista pól, które mają zostać zwrócone w odpowiedzi. Jeśli parametr nie jest ustawiony, zwracane są tylko identyfikatory. Dostępne pola: - id - identyfikator kontaktu - name - nazwa kontaktu - phone - tablica numerów telefonów - email - tablica adresów e-mail - leads - tablica identyfikatorów transakcji - dateCreate - data utworzenia (UNIX) - lastModified - data zmiany (UNIX) |
| limit | integer | Nie | Liczba rekordów zwracanych w wyniku (domyślnie „10000”) |
| page | integer | Nie | Numer zwracanej strony (domyślnie „1”) |
Przykład żądania:
define('TOKEN','XXXXXXXXX');
$data = @file_get_contents(
'https://api.r7k12.com/'.TOKEN.'/getContacts?'.
http_build_query(
[
'fields' => [
'id',
'phone',
'leads'
],
'limit' => 1
]
)
);
Odpowiedź:
{
"page" : 1,
"totalResult": 100,
"data": [
{
"id" : "43",
"phone" : [
"380441234567",
"380503215476"
],
"leads" : [
"1"
]
}
]
}
updateContacts (POST)¶
Metoda updateContacts¶
updateContacts¶
Aktualizacja informacji o istniejących kontaktach. Pozwala zaktualizować dowolny parametr kontaktu (oprócz identyfikatora). W odpowiedzi zwracana jest tablica identyfikatorów zaktualizowanych kontaktów i/lub tablica identyfikatorów kontaktów, które nie zostały zaktualizowane, wraz z opisem przyczyny. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/updateContacts Parametry: Tabela 1 Content-type: application/json Tabela 1
| Parametr | Typ | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator kontaktu w CRM. |
| name | string | Nie | Nazwa kontaktu |
| phone | array [string] | Nie | Tablica nowych numerów telefonów kontaktu, które należy dodać |
| array [string] | Nie | Tablica adresów e-mail kontaktu, które należy dodać | |
| leads | array [string] | Nie | Tablica identyfikatorów transakcji, z którymi powiązany jest ten kontakt, które należy dodać |
Przykład treści żądania:
[
{
"name": "Name update",
"id": "1"
},
{
"id": "2",
"phone": [
"380441234560"
]
},
{
"id": "3",
"email": [
"[email protected]"
],
"leads": [
"679"
]
}
]
Przykład odpowiedzi:
{
"upload" : [1,2,3],
"notUpdate" : [,
{
"id" : 5,
"message" : "Контакт с указанным идентификатором не существует"
}
]
}
Przykład skryptu (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)¶
Metoda deleteContacts¶
deleteContacts¶
Metoda pozwala usunąć transakcje. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/deleteContacts Parametry: Tabela 1 Content-type: application/json Tabela 1
| Nazwa | Wartość | Wymagany | Opis |
| ids | array[string] | Tak | Tablica unikalnych identyfikatorów kontaktów, które należy usunąć |
Przykład treści żądania:
{
"ids" : [1,2,3]
}
Przykład skryptu (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)¶
Metoda setStatuses¶
Przesyłanie statusów transakcji. Jeśli zostanie przekazany status z ID, który jest już zapisany w serwisie R7K12, status zostanie zaktualizowany. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/setStatuses Parametry: Tabela 1 Content-type: application/json Tabela 1
| Nazwa | Wartość | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator statusu w systemie CRM |
| group | integer | Tak | Grupa, do której należy status. Wartość od 1 do 4. - 1 - Nieuwzględniane - 2 - W realizacji - 3 - Zrealizowano - 4 - Anulowano |
| name | string | Nie | Nazwa statusu w systemie CRM (nie więcej niż 500 znaków). |
Przykład treści żądania:¶
[
{
"id":"56385",
"group":"1",//Не учитывать
"name":"Новый заказ"
},
{
"id":"57667454",
"group":"3"//Успешно реализовано
}
]
Przykład skryptu (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)¶
Metoda setManagers¶
Metoda pozwala przesłać listę menedżerów systemu CRM. Jeśli zostanie przekazany menedżer z ID, który jest już zapisany w serwisie R7K12, imię menedżera zostanie zaktualizowane. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/setManagers Parametry: Tabela 1 Content-type: application/json Tabela 1
| Nazwa | Wartość | Wymagany | Opis |
| id | string | Tak | Unikalny identyfikator menedżera w systemie CRM |
| name | string | Tak | Imię menedżera |
Przykład treści żądania:¶
[
{
"id":"1",
"name":"Менеджер №1"
},
{
"id":"2",
"name":"Менеджер №2"
}
]
Przykład skryptu (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)¶
Metoda getAppeals¶
getAppeals¶
Metoda pozwala pobrać listę zapytań, które wpłynęły do serwisu R7K12. Metoda zwraca nie więcej niż 10000 rekordów w jednym wywołaniu, a do odpowiedzi na każde żądanie dodawany jest parametr „totalResult” - z łączną liczbą wyników. Metoda: GET Link: https://api.r7k12.com/{{TOKEN}}/getAppeals Parametry: Tabela 1 Tabela 1
| Parametr | Typ | Wymagany | Opis |
| date | string | Nie | Data wpłynięcia zapytania do systemu. Format: - RRRR-MM-DD GG:MM:SS - RRRR-MM-DD. Jeśli podano ten parametr, w odpowiedzi zostaną zwrócone tylko te zapytania, które zostały utworzone po podanej dacie. |
| phone | string | Nie | Numer telefonu podany w zapytaniu. Musi składać się wyłącznie z cyfr Jeśli został podany, zwrócone zostaną tylko te zapytania, w których numer telefonu jest zgodny z podanym numerem. |
| string | Nie | Adres e-mail podany w zapytaniu. Musi być prawidłowym adresem e-mail. Jeśli został podany, zwrócone zostaną tylko te zapytania, w których numer telefonu jest zgodny z podanym adresem email. | |
| fields | array [string] | Nie | Lista pól, które mają zostać zwrócone w odpowiedzi. Jeśli parametr nie jest ustawiony, zwracane są tylko identyfikatory sesji (r7k12id). Dostępne pola: - id - identyfikator zapytania - r7k12id - identyfikator sesji - name - imię podane w zapytaniu - phone - numer telefonu - email - adres email - comment - komentarz - date - data utworzenia (UNIX) - type - typ zapytania - call_duration - czas trwania połączenia - call_record - link do nagrania rozmowy - call_status - status połączenia - price - cena transakcji - href - link do strony, z której wysłano zgłoszenie - raw_data - dane zgłoszenia w takiej postaci, w jakiej zostały otrzymane |
| limit | integer | Nie | Liczba rekordów zwracanych w wyniku (domyślnie „10000”) |
| page | integer | Nie | Numer zwracanej strony (domyślnie „1”) |
Przykład żądania:
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)¶
Metoda updateIdsEssenceCrm¶
updateIdsEssenceCrm¶
Metoda pozwala zaktualizować unikalny identyfikator encji CRM (kontakt/transakcja). Metoda ta jest odpowiednia w przypadku integracji „Własny CRM” i korzystania z modułu wysyłania danych, gdy trzeba zastąpić nadany przez serwis R7K12 identyfikator encji CRM własnym. Metoda: POST Format: JSON Link: https://api.r7k12.com/{{TOKEN}}/updateIdsEssenceCrm Parametry: Tabela 1 Content-type: application/json Tabela 1
| Nazwa | Wartość | Wymagany | Opis |
| type | ENUM (‘lead’, ’contact’) | Tak | Typ encji CRM, której identyfikator należy zmienić |
| oldId | string | Tak | Identyfikator encji, który jest obecnie ustawiony. |
| newId | string | Tak | Identyfikator encji, który należy ustawić. |
Przykład treści żądania:
[
{
"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"
}
]
Przykład odpowiedzi:
[
{
"type":"lead",
"id":"jf97gaossz",//oldId
"status":"success"
},
{
"type":"lead",
"id":"6y62zhzifs",
"status":"error",
"error_message":"Новый идентификатор не является уникальным"
},
{
"type":"contact",
"id":"3reuqfl2di",
"status":"success"
}
]
Przykład skryptu (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)¶
Metoda setShippingTrackingId¶
Metoda pozwala dodać lub zaktualizować numer śledzenia przesyłki w transakcji. Przy podawaniu numeru listu przewozowego firma kurierska musi być podłączona w integracjach R7K12CRM. Maksymalna liczba danych wejściowych — 100. Metoda: POST Link: https://api.r7k12.com/{{TOKEN}}/R7K12Crm Parametry: Tabela nr 1 Dane wejściowe:
{
"method": "setShippingTrackingId",
"input": [
{
"dealId": (string),
"type": (string),
"shippingId": (string)
},
...
]
}
Tabela nr 1
| Parametr | Typ | Wymagany | Opis |
| method | string | Tak | Wywoływana metoda. Zawsze „setShippingTrackingId” |
| input | array[object] | Tak | Parametry wejściowe metody |
| input[index].dealId | string | Tak | Identyfikator transakcji |
| input[index].type | string | Tak | Identyfikator firmy kurierskiej, do której należy numer śledzenia - „novaPoshta” - Nova Poshta |
| input[index].shippingId | string | Tak | Numer śledzenia przesyłki |
Przykład żądania:
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);
Obsługa odpowiedzi:
{
"success": true,
"warning": [
{
"dealId": (string),
"type": (syting),
"shippingId": (string),
"error": (string)
}
]
}
Tabela nr 2
| Parametr | Typ | Wymagany | Opis |
| success | true | Nie | Flaga pomyślnego przetworzenia wszystkich przesłanych danych. Występuje tylko wtedy, gdy wszystkie dane zostały pomyślnie przetworzone |
| warning | array[object] | Nie | Tablica nieprzetworzonych danych wejściowych |
| warning[index].dealId | string | Tak | Identyfikator transakcji |
| warning[index].type | string | Tak | Identyfikator firmy kurierskiej, do której należy numer śledzenia - „novaPoshta” - Nova Poshta |
| warning[index].shippingId | string | Tak | Numer śledzenia przesyłki |
| warning[index].error | string | Tak | Przyczyna, dla której dane nie zostały przetworzone: - 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 |
Błędy API¶
Format odpowiedzi:
{
"error": {
"code": (int),
"error": (string),
"error_detail": (string)
}
}
Tabela nr 3
| Kod | Błąd | Opis |
| -1 | Nie udało się wykonać żądania | Wystąpił wewnętrzny błąd API. Skontaktuj się z pomocą techniczną, podając requestId |
| 20 | Nieprawidłowy klucz dostępu | |
| 21 | Nieprawidłowa metoda | |
| 22 | Nieprawidłowy format danych | |
| 23 | Nie podano wymaganych parametrów | |
| 24 | Integracja z API nie jest podłączona | |
| 25 | Błąd zapisu | |
| 26 | Maksymalna liczba rekordów w żądaniu to 100 | |
| 27 | Odstęp między żądaniami musi wynosić co najmniej 3 sekundy | |
| 28 | Brak dostępu do wybranego projektu | |
| 29 | Brak uprawnień do wykonania tej metody | |
| 210 | Do wykonania wybranej metody wymagany jest klucz dostępu użytkownika | Należy uzyskać klucz według schematu OAUTH2 |
| 211 | Token dostępu jest zablokowany | Aby uzyskać dodatkowe informacje, skontaktuj się z pomocą techniczną |
| 212 | Nie można równolegle wykonywać żądań z tymi samymi metodami | Wybrana metoda API jest już używana w równoległym żądaniu z podanym tokenem |
| 301 | Invalid API Method | Wywołano nieprawidłową metodę API R7K12 CRM |
| 302 | R7K12 CRM is not connected in the project | R7K12 CRM nie jest podłączony w projekcie |
| 303 | Integration not connected in R7K12 CRM | Integracja nie jest podłączona w R7K12 CRM |
| 304 | Incorrect input data | Nieprawidłowe dane wejściowe |
| 305 | A lot of data | Przekroczono maksymalną liczbę danych wejściowych |