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

Через API вы сможете работать со своими объявлениями, например, в системе CRM.

На данный момент реализованы следующие возможности:

- получение статистики по уже размещённым объявлениям.

Основные данные

API работает по протоколу HTTPS.

Авторизация осуществляется по значению HTTP-заголовка X-ApiKey.

Все данные передаются в API GET/POST/PUT-параметрами в формате form-urlencoded.

Все данные возвращаются только в формате JSON.

Базовый URL — https://api.allix.ru/v1/product/stat.php

Формат даты: YYYY-MM-DD hh:mm:ss Время МСК.

Получение ключа авторизации

Авторизация осуществляется по параметру X-ApiKey, который следует передавать в заголовках запросов к сервису и является уникальным для каждого зарегистрированного пользователя. Для получения ключа X-ApiKey необходимо отправить запрос в техническую поддержку.

Получение статистики

Запрос

GET /v1/product/stat.php?offer_id={}&apikey={}

Обязательные параметры:

id_offer  - (string) Идентификатор объявления (номер объявления в Вашей системе), например, id_offer=567PrimerID 

 Результат запроса 

 Заголовок:

• 200 OK - успешное выполнение
• 404 Not Found - объявление не найдено или ошибка в параметрах запроса

site - название сайта объявлений Allix.ru;

id_site (string) - номер объявления на сайте объявлений Allix.ru;

id_offer (string) - номер объявления в Вашей системе;

title (string) - заголовок объявления;

url (string) - ссылка на объявление на сайте;

from (date) - дата и время размещения объявления на сайте;

to (date) - дата и время окончания размещения объявления на сайте;

views_all (string) - суммарное количество просмотров объявления (просмотры за всё время);

views_today (string) - суммарное количество просмотров объявления за текущий день;

show_all (string) - суммарное количество показов объявления на сайте (показы за всё время);

show_today (string) - суммарное количество показов объявления на сайте за текущий день;

phone_click_all (string) - суммарное количество кликов на кнопку "Показать телефон";

phone_click_today (string) - суммарное количество кликов на кнопку "Показать телефон" за текущий день.

Пример ответа: