Документация TargetClick API

Данная документация описывает методы TargetClick API. Все запросы требуют API-ключ (secret_key) и id пользователя для авторизации. API поддерживает CORS (кросс-доменные запросы). API поддерживает HTTP протокол.

Где найти API ключ и id пользователя?

Вы можете найти свой API-ключ и id пользователя здесь: https://targetclick.me/system/settings/api/

Структура имени URL запросов

Каждый URL начинается с адреса API (http://api.targetclick.me/method/), за ним следует название метода. Все возможные методы перечислены ниже.

Выполнение запросов к API

Для того чтобы вызвать метод API TargetClick, Вам необходимо осуществить POST или GET запрос по протоколу HTTP на указанный URL:

http://api.targetclick.me/method/'''METHOD_NAME'''?'''PARAMETERS'''&secret_key='''SECRET_KEY'''&id='''CLIENT_ID'''

METHOD_NAME – название метода из списка функций API,
PARAMETERS – параметры соответствующего метода API,
SECRET_KEY – секретный ключ,
CLIENT_ID - id пользователя

Формат ответа

Форматом ответа является JSON.

Ошибки

Все ошибки представляются в виде человеко- и машиночитаемого статуса. По умолчанию, все методы возвращают HTTP статус 200 OK, в том числе и в случае ошибки.

Методы API

Добавить нового клиента

Добавляет нового клиента в CRM-систему (клиенты).
POST
/add-client
Параметры
secret_key
секретный ключ, обязательный параметр
id
идентификатор пользователя, обязательный параметр, целое число
name
ФИО клиента, обязательный параметр, строка
loyalty
лояльность (0 - лояльный, 1 - холодный, 2 - недовольный), целое число
email
e-mail клиента (одно или несколько значений, разделенных запятой), строка
phone
телефон клиента (одно или несколько значений, разделенных запятой), строка
site
сайт, строка
company
название компании, строка
position
должность, строка
gender
пол (0 - мужской, 1- женский), целое число
Результат

Возвращает массив ответов на запрос. В случае удачи возвращает поле {"success":1}. В случае возникновения ошибки возвращает поле {"error": {...}} содержащее поля error_code и error_desc.

Коды ошибок можно посмотреть здесь

Добавить новый товар

Добавляет новый товар в CRM-систему (склад).
POST
/add-product
Параметры
secret_key
секретный ключ, обязательный параметр
id
идентификатор клиента, обязательный параметр, целое число
name
название товара, обязательный параметр, строка
description
описание товара, строка
price
цена за единицу товара, обязательный параметр, тип целое или с плавающей точкой
measure_unit
единица измерения (0 - не выбрана, 1 - м., 2 - л., 3- г., 4 - кг., 5 - шт., 6 - упаковка, 7 - ц.), целое число
tax
налог (%), целое число
amount
количество товара, целое число
weight
вес (нетто), строка, допустимо указание единиц измерения (Например: 200гр.)
size
объем (м3), строка, допустимо указание размера (Например: 20х30х40)
articul
артикул, строка
code
код, строка
Результат

Возвращает массив ответов на запрос. В случае удачи возвращает поле {"success":1}. В случае возникновения ошибки возвращает поле {"error": {...}} содержащее поля error_code и error_desc.

Коды ошибок можно посмотреть здесь

Коды ошибок

1
Неверный запрос.
URL сформирован некорректно. Возможно указано некорретное название метода. Список методов приведен выше.
2
Неверное имя метода.
Проверьте правильность передаваемого названия метода. Список методов приведен выше.
3
Ошибка авторизации. Отсутствуют параметры.
Проверьте, переданы ли параметры secret_key, id.
4
Ошибка авторизации. Неверные значения параметров.
Проверьте корретность передаваемых параметров secret_key, id.
5
Отстутствуют необходимые параметры метода.
Проверьте список используемых параметров (его можно найти в блоке с описанием метода).

Пример запроса

Ниже приведен пример запроса метода добавления нового товара

curl -X POST --header "Accept: application/json" -d "{}" "http://api.targetclick.me/method/add-product?secret_key={secret_key}&id={client_id}&name={product_name}&price={price}&amount={amount}"