HipHop BY
HipHop BY Зайцев.FM Поп-музыка Зайцев.FM DISCO Зайцев.FM Club Спокойное радио Радио Нашествие Радио свобода Дискотека 80-90
Время на сервере
27.04.2024 10:23:13

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

Формат запроса

Все запросы выполняются на URL: https://dynamic-company.ru/api/v1/ (GET, POST, JSON), в каждом запросе должны присутствовать обязательные 2 параметра api_key и method. По их содержимому производится авторизация и вызов метода.

Параметр Требуется Тип Описание
api_key Да string API ключ (получить)
method Да string Метод API

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

В ответ выдаётся JSON строка, содержащая массив в котором всегда будет присутствовать как минимум 1 элемент.

Параметр Тип Описание
success bool true - запрос успешно выполнен.
false - ошибка выполнения запроса.
error->code int Код ошибки, если success отличен от true
1хx - ошибка на этапе авторизации.
2хх - ошибка на этапе выполнения API метода.
error->message string Текст поясняющий ошибку, если success отличен от true
Пример ответа с ошибкой 
{
    "success":false,
    "error":{
        "code":101,
        "message":"Описание ошибки"
    }
}

Доступные API методы

method Описание
getAccount Информация о владельце API ключа
create Создание компании
edit Редактирование компании
getInfo Информация о компании
addBalance Добавить выполнения
changeStatus Изменить статус компании
refundBalance Возврат остатка средств
delete Удаление компании

Метод getAccount

Описание: выдаёт базовую информацию о владельце API ключа.

Параметры для запроса
Параметр Требуется Тип Описание
api_key Да string API ключ
method Да string Метод API: getAccount
Пример запроса 
{
    "api_key":"00000000-04567f3f4a06359xxxxx",
    "method":"getAccount"
}
Пример успешного ответа 
{
    "success":true,
    "balance":13948.1,
    "currency":"RUB"
}
Параметры ответа
Параметр Тип Описание
balance float Баланс в рублях
currency string Валюта RUB

Метод create

Описание: создание новой рекламной компании.

Параметры для запроса
Параметр Требуется Тип Описание
api_key Да string API ключ
method Да string Метод API: create
type Да string Тип рекламной компании

Доступные значение:
view - просмотр видео Youtube
amount Да int Количество выполнений
link Да string Ссылка на рекланую компанию Youtube
timer Нет int Таймер для типа view (в секундах), без установки назначается оптимальный.

Доступные значение: от 5 до 900 сек.
5 - (по умолчанию)
title Нет string Краткое описание компании
ip_user Нет int Уникальный IP адрес

Доступные значение:
0 - отключено (по умолчанию)
1 - Только с уникальных IP адресов
2 - Усиленный по маске до 2 чисел (255.255.)
inter Нет int Интервал раздачи

Доступные значение:
0 - отключено (по умолчанию)
1 - по каждому часу
2 - фиксированный интервал
inter_data Нет int
string		 Настройки интервала (подробнее)
target Нет int Ограничение по геотаргетингу

Доступные значение:
0 - отключено (по умолчанию)
1 - только указанные страны
target_code Нет string Список стран. Указываются текстовые значения в формате ISO, разделенные знаком запятой (пример ru,ua,ge)
Пример запроса 
{
    "api_key":"00000000-04567f3f4a06359xxxxx",
    "method":"create",
    "type":"view",
    "link":"https://www.youtube.com/shorts/QRYjCEIDMkk",
    "title":"Test",
    "amount":1000,
    "timer":10
}
Пример успешного ответа 
{
    "success":true,
    "id":1,
    "type":"view",
    "balance":25,
    "startCount":100
}
Параметры ответа
Параметр Тип Описание
id int ID компании
type string Тип рекламной компании

Доступные значение:
view - просмотр видео Youtube
balance float Баланс компании (в рублях)
startCount int Количества действий на момент создания компании. Для типа view, в остальных типах будет показан 0

Метод edit

Описание: редактирование компании.

Параметры для запроса
Параметр Требуется Тип Описание
api_key Да string API ключ
method Да string Метод API: edit
type Да string Тип рекламной компании

Доступные значение:
view - просмотр видео Youtube
id Да int ID компании
title Нет string Краткое описание компании
ip_user Нет int Уникальный IP адрес

Доступные значение:
0 - отключено (по умолчанию)
1 - Только с уникальных IP адресов
2 - Усиленный по маске до 2 чисел (255.255.)
inter Нет int Интервал раздачи

Доступные значение:
0 - отключено (по умолчанию)
1 - по каждому часу
2 - фиксированный интервал
inter_data Нет int
string		 Настройки интервала (подробнее)
target Нет int Ограничение по геотаргетингу

Доступные значение:
0 - отключено (по умолчанию)
1 - только указанные страны
target_code Нет string Список стран. Указываются текстовые значения в формате ISO, разделенные знаком запятой (пример ru,ua,ge)
Пример запроса 
{
    "api_key":"00000000-04567f3f4a06359xxxxx",
    "method":"edit",
    "type":"view",
    "id":1,
    "title":"Test new"
}
Пример успешного ответа 
{
    "success":true
}

Метод getInfo

Описание: вывод информацию о компании, если не указывать id выведет список существующих компаний.

Параметры для запроса
Параметр Требуется Тип Описание
api_key Да string API ключ
method Да string Метод API: getInfo
type Да string Тип рекламной компании

Доступные значение:
view - просмотр видео Youtube
id Да int ID компании
Пример запроса 
{
    "api_key":"00000000-04567f3f4a06359xxxxx",
    "method":"getInfo",
    "type":"view",
    "id":1
}
Пример успешного ответа 
{
    "success":true,
    "list":[
        {
            "id":1,
            "status":0,
            "status_msg":"active",
            "type":"view",
            "amount":999,
            "amountDone":1,
            "balance":29.97,
            "link":"gFn434YBq7k",
            "title":"Test",
            "timer":10,
            "price_u":0.02,
            "price_r":0.03,
            "status_ban":false,
            "startCount": 100,
            "ip_user": 0,
            "inter":0,
            "inter_data":"",
            "target":0,
            "target_code":""
        }
    ]
}
Параметры ответа
Параметр Тип Описание
list array Массив списка компаний
Параметры в массиве list
id int ID компании
status int 0 - компания остановлена, не активна
1 - компания активная, в работе
2 - компания заблокирована
status_msgstring active - компания активная, в работе
completed - компания остановлена, не активна
typestring view - просмотр видео Youtube
amount int Осталось выполнений компании
amountDone int Сколько исполнений компании уже было
balance float Баланс компании (в рублях)
link string Ссылка на рекланую компанию
title string Заголовок компании
timer int Таймер для типа serf, view_youtube, view_rutube (в секундах)
price_ufloat Цена оплаты исполнителю
price_r float Цена оплаты за одно действие компании
status_ban bool Компания заблокирована
true - да false - нет
startCountint Количества действий на момент создания компании. Для типа view_youtube, sub_youtube, like_youtube, в остальных типах будет показан 0
ip_user int Уникальный IP адрес

Доступные значение:
0 - отключено (по умолчанию)
1 - Только с уникальных IP адресов
2 - Усиленный по маске до 2 чисел (255.255.)
inter int Интервал раздачи

Доступные значение:
0 - отключено
1 - по каждому часу
2 - фиксированный интервал
inter_data int
string		 Настройки интервала (подробнее)
target int Ограничение по геотаргетингу

Доступные значение:
0 - отключено
1 - только указанные страны
target_code string Список стран. Указываются текстовые значения в формате ISO, разделенные знаком запятой (пример ru,ua,ge)

Метод addBalance

Описание: пополнение баланса компании.

Параметры для запроса
Параметр Требуется Тип Описание
api_key Да string API ключ
method Да string Метод API: addBalance
type Да string Тип рекламной компании

Доступные значение:
view - просмотр видео Youtube
id Да int ID компании
amount Да int Количество выполнений компании
Пример запроса 
{
    "api_key":"00000000-04567f3f4a06359xxxxx",
    "method":"addBalance",
    "type":"view",
    "id":1,
    "amount":1000
}
Пример успешного ответа 
{
    "success":true,
    "balance":25.43
}
Параметры ответа
Параметр Тип Описание
balance float Сумма в рублях которая была внесена на баланс компании

Метод changeStatus

Описание: управление компанией (остановка, запуск)

Параметры для запроса
Параметр Требуется Тип Описание
api_key Да string API ключ
method Да string Метод API: changeStatus
type Да string Тип рекламной компании

Доступные значение:
view - просмотр видео Youtube
id Да int ID компании
status Да int Запустить или остановить компанию

Доступные значение:
0 - Остановить
1 - Запустить
Пример запроса 
{
    "api_key":"00000000-04567f3f4a06359xxxxx",
    "method":"changeStatus",
    "type":"view",
    "id":1,
    "status":1
}
Пример успешного ответа 
{
    "success":true,
    "status":"active"
}
Параметры ответа
Параметр Тип Описание
status string Статус компании:
active - компания активная, в работе
completed - компания остановлена, не активна

Метод refundBalance

Описание: возврат неизрасходованных средств, на рекламный счет.

Параметры для запроса
Параметр Требуется Тип Описание
api_key Да string API ключ
method Да string Метод API: refundBalance
type Да string Тип рекламной компании

Доступные значение:
view - просмотр видео Youtube
id Да int ID компании
Пример запроса 
{
    "api_key":"00000000-04567f3f4a06359xxxxx",
    "method":"refundBalance",
    "type":"view",
    "id":1
}
Пример успешного ответа 
{
    "success":true,
    "balance":21.35
}
Параметры ответа
Параметр Тип Описание
balance float Сумма в рублях которая была возвращена на рекламный счет

Метод delete

Описание: удаление компании. Перед удалением рекламную компанию нужно остановить и подождать 10 минут.

Параметры для запроса
Параметр Требуется Тип Описание
api_key Да string API ключ
method Да string Метод API: delete
type Да string Тип рекламной компании

Доступные значение:
view - просмотр видео Youtube
id Да int ID компании
Пример запроса 
{
    "api_key":"00000000-04567f3f4a06359xxxxx",
    "method":"delete",
    "type":"view",
    "id":1
}
Пример успешного ответа 
{
    "success":true,
    "balance":0
}
Параметры ответа
Параметр Тип Описание
balance float Сумма в рублях которая была возвращена на рекламный счет
578
ЧАТ
Dynamic-Company.ru использует файлы Cookie с целью персонализации сервисов и повышения удобства пользования веб-сайтом. Подробности в политике конфиденциальности.
×