Фотографии

Фотографии
Информация по работе с объектом Фотографии (photos).

Операции
GET / — Получение списка фотографий.
GET /$id — Получение карточки фотографии.
POST / — Добавление фотографии.
PUT /$id — Обновление фотографии.
DELETE /$id — Удаление фотографии.

Поля
name — Название (Текст).
description — Описание (Текст).
user — Ответственный (Идентификатор пользователя).

Фильтры
name — Название.
user — Ответственный.

Работники

Работники
Информация по работе с объектом Работники (peoples).

Справочники
GET /statuses — Получение списка статусов работников.
GET /custom_fields — Получение списка произвольных полей работников.

Операции
GET / — Получение списка работников.
GET /$id — Получение карточки работника.
POST / — Добавление работника.
PUT /$id — Обновление работника.
DELETE /$id — Удаление работника.

Поля
name — Название (Текст).
description — Описание (Текст).
phone — Телефон 1 (Текст).
phone2 — Телефон 2 (Текст).
phone3 — Телефон 3 (Текст).
phone4 — Телефон 4 (Текст).
phone5 — Телефон 5 (Текст).
email — Email 1 (Текст).
email2 — Email 2 (Текст).
email3 — Email 3 (Текст).
email4 — Email 4 (Текст).
email5 — Email 5 (Текст).
status — Статус (Идентификатор статуса).
user — Ответственный (Идентификатор пользователя).

Фильтры
name — Название.
phone — Телефон.
email — Email.
user — Ответственный.

Платежи

Платежи
Информация по работе с объектом Платежи (payments).

Справочники
GET /custom_fields — Получение списка произвольных полей платежей.

Операции
GET / — Получение списка платежей.
GET /$id — Получение карточки платежи.
POST / — Добавление платежа.
PUT /$id — Обновление платежа.
DELETE /$id — Удаление платежа.

Поля
name — Название (Текст).
description — Описание (Текст).
deal — Сделка (Идентификатор сделки).
user — Ответственный (Идентификатор пользователя).

Фильтры
name — Название.
user — Ответственный.

Организация

Организация
Информация по работе с объектом Организация (organization).

Операции
GET / — Получение информации по аккаунту организации.

Поля
name — Название (Текст).
balance — Баланс (Число).

Заказы

Заказы
Информация по работе с объектом Заказы (orders).

Справочники
GET /statuses — Получение списка статусов заказов.
GET /custom_fields — Получение списка произвольных полей заказов.

Операции
GET / — Получение списка заказов.
GET /$id — Получение карточки заказа.
POST / — Добавление заказа.
PUT /$id — Обновление заказа.
DELETE /$id — Удаление заказа.

Поля
name — Название (Текст).
description — Описание (Текст).
d_start — Дата заказа (Дата).
account — Организация (Идентификатор организации).
contact — Контакт (Идентификатор контакта).
status — Статус (Идентификатор статуса).
user — Ответственный (Идентификатор пользователя).

Фильтры
name — Название.
user — Ответственный.

//Пример добавления заказа с заполнением значения произвольного поля на PHP
$apikey = "Ваш API-ключ";

//Получаем список произвольных полей в заказах
$url = "https://wirecrm.com/api/v1/orders/custom_fields";
$headers = array("X-API-KEY:".$apikey
);
$handle = curl_init();
curl_setopt($handle, CURLOPT_URL, $url);
curl_setopt($handle, CURLOPT_USERAGENT, "WireCRM Rest API");
curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
$data = curl_exec($handle);
curl_close($handle);

//Добавляем заказ
$url = "https://wirecrm.com/api/v1/orders";
$headers = array("X-API-KEY:".$apikey);
$data = '{"name":"Заказ клиента","description":"Покупка через сайт","custom_fields":{"4":"Значение"}}';
$handle = curl_init();
curl_setopt($handle, CURLOPT_URL, $url);
curl_setopt($handle, CURLOPT_USERAGENT, "WireCRM Rest API");
curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($handle, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
$data = curl_exec($handle);
curl_close($handle);
//Пример добавления заказа с указанием статуса на PHP
$apikey = "Ваш API-ключ";

//Список статусов заказов
//Можно получить GET запросом https://wirecrm.com/api/v1/orders/statuses
$order_status_id = "ID статуса";

//Добавляем заказ
$url = "https://wirecrm.com/api/v1/orders";
$headers = array("X-API-KEY:".$apikey);
$data = '{"name":"Заказ клиента","description":"Покупка через сайт","status":"'.$order_status_id.'"}';
$handle = curl_init();
curl_setopt($handle, CURLOPT_URL, $url);
curl_setopt($handle, CURLOPT_USERAGENT, "WireCRM Rest API");
curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($handle, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
$data = curl_exec($handle);
curl_close($handle);

Объекты

Объекты
Информация по работе с объектом Объекты (objects).

Операции
GET / — Получение списка объектов.

Поля
name — Название (Текст).
code — Системное название (Текст).

//Пример получения списка объектов на PHP
$url = "https://wirecrm.com/api/v1/objects";
$apikey = "Ваш API-ключ";

$headers = array("X-API-KEY:".$apikey);

$handle = curl_init(); 
curl_setopt($handle, CURLOPT_URL, $url);
curl_setopt($handle, CURLOPT_USERAGENT, "WireCRM Rest API");
curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);

$data = curl_exec($handle);
curl_close($handle);

Заметки

Заметки
Информация по работе с объектом Заметки (notes).

Операции
GET / — Получение списка заметок.
GET /$id — Получение карточки заметки.
POST / — Добавление заметки.
PUT /$id — Обновление заметки.
DELETE /$id — Удаление заметки.

Поля
name — Название (Текст).
description — Описание (Текст).
user — Ответственный (Идентификатор пользователя).

Фильтры
name — Название.
user — Ответственный.

Холодные контакты

Холодные контакты
Информация по работе с объектом Холодные контакты (leads).

Справочники
GET /statuses — Получение списка статусов холодных контактов.
GET /sources — Получение списка источников холодных контактов.
GET /custom_fields — Получение списка произвольных полей холодных контактов.

Операции
GET / — Получение списка холодных контактов.
GET /$id — Получение карточки холодного контакта.
POST / — Добавление холодного контакта.
PUT /$id — Обновление холодного контакта.
DELETE /$id — Удаление холодного контакта.

Поля
name — Название (Текст).
description — Описание (Текст).
phone — Телефон 1 (Текст).
phone2 — Телефон 2 (Текст).
phone3 — Телефон 3 (Текст).
phone4 — Телефон 4 (Текст).
phone5 — Телефон 5 (Текст).
email — Email 1 (Текст).
email2 — Email 2 (Текст).
email3 — Email 3 (Текст).
email4 — Email 4 (Текст).
email5 — Email 5 (Текст).
site — Сайт (Текст).
company — Организация (Идентификатор организации).
source — Источник (Идентификатор источника).
status — Статус (Идентификатор статуса).
city — Город (Текст).
region — Регион (Текст).
address — Адрес (Текст).
utm_campaign — UTM Campaign (Текст).
utm_content — UTM Content (Текст).
utm_medium — UTM Medium (Текст).
utm_source- UTM Source (Текст).
utm_term — UTM Term (Текст).
utm_age — UTM Age (Текст).
utm_geo — UTM Geo (Текст).
clientid — Client ID (Текст).
user — Ответственный (Идентификатор пользователя).

Фильтры
name — Название.
phone — Телефон.
email — Почта.
user — Ответственный.

//Пример добавления холодного контакта с указанием UTM меток (utm_campaign, utm_content, utm_medium, utm_source, utm_term) на PHP

$apikey = "Ваш API-ключ";
$url = "https://wirecrm.com/api/v1/leads";
$headers = array("X-API-KEY:".$apikey);
$data = '{"name":"Игорь","phone":"79191122333","email":"test@test.com","description":"Новая заявка","utm_campaign":"kommercheskaya_nedvizhimost","utm_content":"1234567890","utm_medium":"cpc","utm_source":"yandex","utm_term":"kupit_odnokomnatnuju_kvartiru"}';
$handle = curl_init();
curl_setopt($handle, CURLOPT_URL, $url);
curl_setopt($handle, CURLOPT_USERAGENT, "WireCRM Rest API");
curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($handle, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
$data = curl_exec($handle);
curl_close($handle);
//Пример добавления холодного контакта с указанием статусы и источника на PHP
$apikey = "Ваш API-ключ";

//Список статусов холодных контактов
//Можно получить GET запросом https://wirecrm.com/api/v1/leads/statuses
$lead_status_id = "ID статуса";

//Список источников холодных контактов
//Можно получить GET запросом https://wirecrm.com/api/v1/leads/sources
$lead_source_id = "ID источника";

//Добавляем холодный контакт
$url = "https://wirecrm.com/api/v1/leads";
$headers = array("X-API-KEY:".$apikey);
$data = '{"name":"Игорь","phone":"79191122333","email":"test@test.com","description":"Новая заявка с сайта","status":"'.$lead_status_id.'","source":"'.$lead_source_id.'"}';
$handle = curl_init();
curl_setopt($handle, CURLOPT_URL, $url);
curl_setopt($handle, CURLOPT_USERAGENT, "WireCRM Rest API");
curl_setopt($handle, CURLOPT_HTTPHEADER, $headers);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($handle, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
$data = curl_exec($handle);
curl_close($handle);

Счета

Счета
Информация по работе с объектом Счета (invoices).

Справочники
GET /statuses — Получение списка статусов счетов.
GET /custom_fields — Получение списка произвольных полей счетов.

Операции
GET / — Получение списка счетов.
GET /$id — Получение карточки счета.
POST / — Добавление счета.
PUT /$id — Обновление счета.
DELETE /$id — Удаление счета.

Поля
name — Название (Текст).
description — Описание (Текст).
d_invoice — Дата счета (Дата).
account — Организация (Идентификатор организации).
contact — Контакт (Идентификатор контакта).
status — Статус (Идентификатор статуса).
user — Ответственный (Идентификатор пользователя).

Фильтры
name — Название.
user — Ответственный.

Приходы

Приходы
Информация по работе с объектом Приходы (incomes).

Справочники
GET /custom_fields — Получение списка произвольных полей приходов.

Операции
GET / — Получение списка приходов.
GET /$id — Получение карточки прихода.
POST / — Добавление прихода.
PUT /$id — Обновление прихода.
DELETE /$id — Удаление прихода.

Поля
name — Название (Текст).
description — Описание (Текст).
user — Ответственный (Идентификатор пользователя).

Фильтры
name — Название.
user — Ответственный.