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

Приветсвуем на странице документации нашего API.

В данный момент всё достаточно просто, так что изучите документацию перед использованием.

Переключайтесь между вкладками, чтобы узнать больше информации.

Надеемся, всё будет понятно и просто. Если будут сложности или если у Вас есть предложения, то обязательно пишите Вашему менеджеру, мы обязательно поможем Вам!

API токен представляют собой набор случайных знаков латиского алфавита и цифр, длиной 60 символов.

Найти/создать токены можно на странице аккаунта, а так же там находится небольшая статистика по токенам.

Максимально кол-во токенов для одного аккаунта = 5.

Существует ограничение на кол-во запросов с одного ip адреса. Не более 60 запросов в минуту, иначе сервер вернёт ответ с кодом 429 - "Too Many Attempts."

Важно!!! Не передавайте токен в URI при запросе! Если кто-то прослушивает Ваш Wi-Fi трафик, то он может перехватить этот токен и управлять Вашими кампаниями и тд.

Это делать можно, но крайне не рекомендуется. В POST запросе можно передавать токен вместе с остальными параметрами, так же можно использовать Bearer Token или передавать токен с помощью header "PHP_AUTH_PW"

Основное:

  • URI - https://bigclick.me/api/v1/balance
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response* - массив с элементами, который включает в себя:
    • balance* - массив, который включает в себя:
      • web* - баланс вебмастера
      • adv* - баланс рекламодателя
      • par* - баланс партнёра
      • general* - общий баланс

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/campaigns
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • page - страница (от 1 и до бесконечности)
  • per_page - кол-во элементов на страницу ([10,20,30,50,70,100,200,300,400,500])

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response - массив с элементами, который включает в себя:
    • campaigns - массив с элементами, который включает в себя:
      • total - кол-во элементов всего
      • per_page - кол-во элементов на одну страницу
      • current_page - текущая страница
      • last_page - последняя страница
      • next_page_url - ссылка на следующую страницу (null - если отсутствует или строка - если присутствует)
      • prev_page_url - ссылка на предыдущую страницу (null - если отсутствует или строка - если присутствует)
      • from - номер элемента с которого начинается показ данной страницы
      • to - номер элемента на котором закнчивается показ данной страницы
      • data - массив, где перечисляются элементы:
        • id - id кампании
        • name - название кампании
        • status - статус кампании кодом (1 - идут показы, 2 - приостановлена)
        • status_name - статус кампании строкой на русском языке
        • teasersPausedCount - кол-во тизеров на паузе
        • teasersActiveCount - кол-во активных тизеров
        • views - кол-во просмотров за текущий день по МСК
        • clicks - кол-во кликов за текущий день по МСК
        • ctr - CTR за текущий день по МСК
        • costs - потрачено денег за текущий день по МСК

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/campaigns/{id}/teasers
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • {id}* - id кампании
  • page - страница (от 1 и до бесконечности)
  • per_page - кол-во элементов на страницу ([10,20,30,50,70,100,200,300,400,500])

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response - массив с элементами, который включает в себя:
    • teasers - массив с элементами, который включает в себя:
      • total - кол-во элементов всего
      • per_page - кол-во элементов на одну страницу
      • current_page - текущая страница
      • last_page - последняя страница
      • next_page_url - ссылка на следующую страницу (null - если отсутствует или строка - если присутствует)
      • prev_page_url - ссылка на предыдущую страницу (null - если отсутствует или строка - если присутствует)
      • from - номер элемента с которого начинается показ данной страницы
      • to - номер элемента на котором закнчивается показ данной страницы
      • data - массив, где перечисляются элементы:
        • id - id тизера
        • campaign_id - id кампании
        • image - ссылка на изображение тизера
        • text - текст тизера
        • url - ссылка тизера
        • status - статус тизера кодом (1 - заблокирован, 2 - на модерации, 3 - приостановлен, 4 - активен)
        • status_name - статус тизера строкой на русском языке
        • views - кол-во просмотров за текущий день по МСК
        • clicks - кол-во кликов за текущий день по МСК
        • ctr - CTR за текущий день по МСК
        • costs - потрачено денег за текущий день по МСК

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/campaigns/{id}/pause
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • {id}* - id кампании

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/campaigns/{id}/play
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • {id}* - id кампании

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/campaigns/{id}/add-site-to-black
  • Метод - POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • {id}* - id кампании
  • site_id* - id сайта

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/campaigns/{id}/remove-site-from-black
  • Метод - POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • {id}* - id кампании
  • site_id* - id сайта

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/teasers
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • page - страница (от 1 и до бесконечности)
  • per_page - кол-во элементов на страницу ([10,20,30,50,70,100,200,300,400,500])

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response - массив с элементами, который включает в себя:
    • teasers - массив с элементами, который включает в себя:
      • total - кол-во элементов всего
      • per_page - кол-во элементов на одну страницу
      • current_page - текущая страница
      • last_page - последняя страница
      • next_page_url - ссылка на следующую страницу (null - если отсутствует или строка - если присутствует)
      • prev_page_url - ссылка на предыдущую страницу (null - если отсутствует или строка - если присутствует)
      • from - номер элемента с которого начинается показ данной страницы
      • to - номер элемента на котором закнчивается показ данной страницы
      • data - массив, где перечисляются элементы:
        • id - id тизера
        • campaign_id - id кампании
        • image - ссылка на изображение тизера
        • text - текст тизера
        • url - ссылка тизера
        • status - статус тизера кодом (1 - заблокирован, 2 - на модерации, 3 - приостановлен, 4 - активен)
        • status_name - статус тизера строкой на русском языке
        • views - кол-во просмотров за текущий день по МСК
        • clicks - кол-во кликов за текущий день по МСК
        • ctr - CTR за текущий день по МСК
        • costs - потрачено денег за текущий день по МСК

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/teasers/{id}/pause
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • {id}* - id тизера

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/teasers/{id}/play
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • {id}* - id тизера

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/teasers/competitive
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • country - id страны
  • oss - id оператора

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response - массив с элементами (кол-во от 0 до 10), который включает в себя:
    • position* - позиция тизера (целое число)
    • your_teaser* - ваш ли это тизер (true или false)
    • teaser_id* - id тизера (0 если это не ваш тизер)
    • campaign_id* - id кампании (0 если это не ваша кампания)
    • good_type* - тип конечной цели (строка)
    • views* - кол-во просмотров за всё время
    • clicks* - кол-во кликов за всё время
    • ctr* - CTR
    • cpm* - CPM
    • bid* - цена клика

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/advertiser/teasers/{id}/stat-by-site
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • {id}* - id тизера

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response - массив с элементами, который включает в себя:
    • total - кол-во сайтов, которые перечислены в массиве data
    • data - массив со статистикой по сайтам (id элемента(offset) - это id сайта), который включает в себя:
      • site_id - id сайта
      • views - кол-во просмотров за текущий день по МСК
      • clicks - кол-во кликов за текущий день по МСК
      • ctr - CTR за текущий день по МСК
      • costs - расходы за текущий день по МСК

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/webmaster/sites/stat
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен
  • dates - даты. Например, 09/04/2018-10/04/2018. В формате d/m/Y-d/m/Y

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response - массив с элементами, который включает в себя:
    • total - кол-во сайтов, которые перечислены в массиве data
    • data - массив с сайтами, который включает в себя:
      • site_id - id сайта
      • stat - массив со статистикой сайта по указанным датам (один элемент - один день), который включает в себя:
        • date - дата в фаормате d/m/Y (строка)
        • views - кол-во просмотров
        • clicks - кол-во кликов
        • ctr - CTR
        • profit - прибыль

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/country
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response - массив с элементами, который включает в себя:
    • total - кол-во стран, которые перечислены в массиве data
    • data - массив со странами, каждый элемент включает в себя:
      • id - id страны
      • name - название старны

* - обязательные параметры

Основное:

  • URI - https://bigclick.me/api/v1/operator
  • Метод - GET/POST
  • Фотмат ответа - JSON

Входящие параметры:

  • api_token* - api токен

Парметры, возвращаемые сервером:

  • success* - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code* - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs* - массив с сообщениями. Включает в себя:
    • error* - массив с ошибками (строки)
    • success* - массив с подтверждеением удачных операций (строки)
    • warning* - массив с предупреждениями (строки)
    • info* - массив с доп. информацией (строки)
  • response - массив с элементами, который включает в себя:
    • total - кол-во операторов, которые перечислены в массиве data
    • data - массив с операторами, каждый элемент включает в себя:
      • id - id оператора
      • name - название оператора

* - обязательные параметры