Описание API

API Linkum предназначено для рекламодателей, у которых есть своя CRM, откуда им бы хотелось создавать заказы на крауд, соц.ссылки или отзывы, не используя при этом интерфейс Linkum.

Чтобы выполнить одну из функций ниже, вам нужно сделать POST запрос на адрес https://api.linkum.ru/json/v1/{функция}/ с параметрами $initial в виде JSON-строки.

Например, чтобы получить список созданных заказов за 1 января 2019 года, вам нужно сделать POST запрос на адрес https://api.linkum.ru/json/v1/orders_list/ с отправленной в POST параметрах JSON-строкой {"date_create_from":"2019-01-01","date_create_to":"2019-01-02"}

Авторизация:

Во всех запросах нужно отправлять заголовок с токеном, который предварительно должен быть сгенерирован на странице настроек API. Authorization: Bearer {токен}

Функции:

  • (struct) user_data() — Данные пользователя. Возвращается словарь с логином, email и балансом.
  • (struct) regions_list() — Список доступных регионов. Возвращается словарь с id и названием региона.
  • (struct) orders_list($initial) — Список созданных заказов. Возвращается список со словарями - параметрами заказов (возможные поля см. в методе order_create). Плюс в каждом словаре заказа есть ключ placements, значение которого это словарь, где в ключе статус, а в значении список выполненных размещений по заказу в этом статусе. В параметрах функции должен быть передан хотя бы один атрибут.
    • [(int) order_id] — id заказа,
    • [(string) tag] — пользовательский тег для заказа, не более 30 символов; позволяет привязать к заказу любой удобный вам идентификатор,
    • [(string) status] — статус заказа: new (запущено), stop (остановлено) (необязательный параметр; по-умолчанию, new),
    • [(string) date_create_from] — дата создания заявки, от (формат YYYY-MM-DD [HH:mm:ii]),
    • [(string) date_create_to] — дата создания заявки, до (формат YYYY-MM-DD [HH:mm:ii]).
  • (int) order_create($initial) — Создать заказ на ссылки. Возвращается id заказа.
    • (string) url — домен или урл для размещения,
    • (int) num_placements — сколько нужно ссылок,
    • (float) price — цена для рекламодателя,
    • (string) placement_type — тип размещения, возможные значения
    • (boolean) is_concrete_url — размещать ли на конкретную страницу, если false - то на любую с сайта,
    • [(string) status] — статус заказа: new (запущено), stop (остановлено) (необязательный параметр; по-умолчанию, new),
    • [(array/string) categories] — требуемые тематики (необязательный параметр, свободная строка; по-умолчанию, без тематики),
    • [(string) tag] — пользовательский тег для заказа, не более 30 символов; позволяет привязать к заказу любой удобный вам идентификатор,
    • [(string) message] — текст для размещения,
    • [(string) order_comment] — комментарий к заказу для исполнителя,
    • [(array/int) region_ids] — регион заказа (см. метод regions_list),
    • [(string) date_start] — дата со временем, когда заказ нужно отдать исполнителям (формат YYYY-MM-DD [HH:mm:ii]),
    • [(int) min_age] — нужный возраст при покупке в соц.сетях, от,
    • [(int) max_age] — нужный возраст при покупке в соц.сетях, до,
    • [(string) gender] — нужный пол при покупке в соц.сетях,
    • [(string) marital_status] — нужное семейное положение при покупке в соц.сетях,
    • [(int) min_friends_count] — нужное кол-во друзей при покупке в соц.сетях, от,
    • [(int) max_friends_count] — нужное кол-во друзей при покупке в соц.сетях, до,
    • [(int) daily_limit] — кол-во выполнений, которые можно разместить в один день.
  • (struct) order_change_status($initial) — Изменение статуса заказа. Возвращается словарь с параметрами заказа (возможные поля см. в методе order_create).
    • (int) order_id — id заказа,
    • (string) status — статус заказа: new (запущено), stop (остановлено), deleted (удалено).
  • (struct) placements_list($initial) — Список выполненных размещений. Возвращается список со словарями - параметрами размещений. В параметрах функции должен быть передан хотя бы один атрибут.
    • [(list) placement_ids] — id размещений,
    • [(string) date_create_from] — дата создания заявки, от (формат YYYY-MM-DD [HH:mm:ii]),
    • [(string) date_create_to] — дата создания заявки, до (формат YYYY-MM-DD [HH:mm:ii]).
  • (struct) placement_change_status($initial) — Модерация выполнения рекламодателем. Модерировать можно только выполнение в статусе wait_advertiser. Возвращается словарь с параметрами выполнения.
    • (int) placement_id — id выполнения,
    • (string) status — статус выполнения: approved (одобрить), rework (отправить на доработку),
    • (string) reason — причина доработки или отклонения.

Типы размещений:

  • 6 — В любой системе вопросов и ответов
    8 — В любой системе вопросов и ответов, кроме Mail.ru
    1 — Только в системе вопросов и ответов Mail.ru
    7 — Только форумы и блоги
    2 — Пост в ленте ВКонтакте
    3 — Пост в ленте Facebook
    12 — Пост в ленте МойМир@Mail.ru
    14 — Пост в ленте Twitter
    11 — Репост в ленте ВКонтакте
    9 — Репост в ленте Facebook
    13 — Репост в ленте МойМир@Mail.ru
    15 — Репост в ленте Twitter
    16 — В любой системе отзывов и картах

Виды ошибок:

  • 1000 — Service is temporarily inactive
    1001 — Available version API is one of {value}
    1002 — Function name not received
    1003 — Header Authorization is required
    1004 — Unsupported initial data. JSON is required
    1005 — Unsupported initial data. Array is required
    1006 — Authorization access token can not be empty
    1007 — Unknown function name {value}
    1008 — Initial key {value} is required
    1009 — Any initial key is required
    1010 — Token is invalid
    2001 — No order {value}
    2002 — Order already have status {value}
    2003 — Unknown status {value}
    2004 — Initials date_create_from and date_create_to can be used only together
    2005 — Range date_create_from and date_create_to can not be more then one month
    2006 — Initial date_create_to should be greater than date_create_from
    2007 — List ids for placements should be array of integers or integer
    2008 — Wrong placement status {value}
    2009 — Wrong placement type {value}
Новости
Правила системы
Вопросы и ответы
Помощь и поддержка
Разработчикам / API
Реклама на сайте

© 2019 Сервис Linkum.ru.