API Основы

Работа с API WireCRM редставляет собой набор команд, отправляемых посредством HTTP запросов к нашему сервису. Вы можете начать использование API сразу после регистрации, для этого потребуется получить ключ в профиле пользователя. Команды отправляются в формате GET, POST, PUT, DELETE HTTP протокола в кодировке UTF-8. Для расшифровки результата используйте функцию json_decode. Для того чтобы начать использовать API WireCRM, необходимо получить API-ключ. Для авторизации запросов необходимо передать Header X-API-KEY.

API-сервер: https://wirecrm.com/api/v1/
API-ключ : https://secure.wirecrm.com/profile
Кодировка: UTF-8
Результат: JSON

Форматы
Дата: Y-m-d
Время: H:i:s
Дата и время: Y-m-d H:i:s

Методы
GET — Получение и поиск записей.
POST — Добавление записи.
PUT — Обновление записи.
DELETE — Удаление записи.

Типы данных
Идентификатор (Число, автоинкремент)
Текст (255 символов)
Идентификатор (Число)
Флаг (0,1)

Постраничная навигация
offset - Сдвиг (По умолчанию 0)
limit - Количество строк для отображения (По умолчанию 100)
count - Общее количество строк (Только для чтения)

//Пример добавления организации на PHP

$url = "https://wirecrm.com/api/v1/accounts";

$apikey = "Ваш API-ключ";

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

$data = '{"name":"Рога и копыта","description":"Описание организации"}';

$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);