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

Общие сведения

Вы полностью отвечаете за все действия произведённые через API. При создании излишней нагрузки или не целевом использовании API, доступ к API для вас может быть заблокирован/ограничен.

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

Все запросы выполняются на URL: https://serfclick.net/api_youtube.php (POST запрос), в каждом запросе должны присутствовать обязательные 2 параметра api_key и method. По их содержимому производится авторизация и вызов метода. Запросы принимаются только с тех ip адресов, что указаны в созданном вами API ключе.

Параметр	Требуется	Тип	Описание
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

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

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

Метод getAccount

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

Параметры для запроса:

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

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

{
    "api_key":"IW3YNXX3-05037f3f4a063596c4160d3d799413be",
    "method":"getAccount"
}

Пример успешного ответа:

{
    "success":true,
    "balance":13948.1,
    "currency":"RUB"
}

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

Параметр	Тип	Описание
balance	float	Баланс в рублях
currency	string	Валюта RUB

Метод create

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

Параметры для запроса:

Параметр	Требуется	Тип	Описание
api_key	Да	string	API ключ
method	Да	string	Метод API
type	Да	string	Тип компании: view - Просмотр видео (по умолчанию)
link	Да	string	Ссылка на видео
title	Да	string	Заголовок компании, отображается в списке для исполнителя
amount	Да	int	Количество выполнений
timer	Нет	int	Таймер для типа view (в секундах), без установки назначается оптимальный. Доступные значение: 5, 10, 20, 40, 60, 80, 100, 120
source	Нет	int	Источники трафика для типа view: 0 - Скрытый источник (по умолчанию) 1 - serfclick.net
vip	Нет	int	Разместить в VIP блоке для типа view: 0 - Нет 1 - Да
texno	Нет	int	Технология просмотра для типа view: 0 - 1 раз в 24 часа (по умолчанию) 1 - 1 пользователь = 1 выполнение 2 - 1 раз в 1 час 3 - 1 раз в 3 часа 4 - 1 раз в 6 часов 5 - 1 раз в 12 часов
ip_user	Нет	int	Уникальный IP адрес для типа view: 0 - любые IP адреса (по умолчанию) 1 - только уникальные IP адреса 2 - усиленные по маске до 2 чисел (255.255.)
user_date_reg	Нет	int	Ограничение по дате регистрации: 0 - любая дата регистрации (по умолчанию) 1 - до 7 дней регистрации 2 - более 7 дней регистрации

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

{
    "api_key":"IW3YNXX3-05037f3f4a063596c4160d3d799413be",
    "method":"create"
    "type":"view"
    "link":"https://www.youtube.com/watch?v=gFn434YBq7k"
    "title":"Тестовая компания"
    "amount":1000
    "timer":10
}

Пример успешного ответа:

{
    "success":true,
    "id":1,
    "balance":30.5,
    "startCount":1000
}

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

Параметр	Тип	Описание
id	int	ID компании
balance	float	Баланс компании (в рублях)
startCount	int	Количества действий (view) на момент создания площадки.

Метод edit

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

Параметры для запроса:

Параметр	Требуется	Тип	Описание
api_key	Да	string	API ключ
method	Да	string	Метод API
type	Нет	string	Тип компании: view - Просмотр видео (по умолчанию)
id	Да	int	ID компании
title	Нет	string	Заголовок компании, отображается в списке для исполнителя
texno	Нет	int	Технология просмотра для типа view: 0 - 1 раз в 24 часа (по умолчанию) 1 - 1 пользователь = 1 выполнение 2 - 1 раз в 1 час 3 - 1 раз в 3 часа 4 - 1 раз в 6 часов 5 - 1 раз в 12 часов
ip_user	Нет	int	Уникальный IP адрес для типа view: 0 - любые IP адреса (по умолчанию) 1 - только уникальные IP адреса 2 - усиленные по маске до 2 чисел (255.255.)
user_date_reg	Нет	int	Ограничение по дате регистрации: 0 - любая дата регистрации (по умолчанию) 1 - до 7 дней регистрации 2 - более 7 дней регистрации

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

{
    "api_key":"IW3YNXX3-05037f3f4a063596c4160d3d799413be",
    "method":"edit"
    "type":"view"
    "id":1
    "title":"Тестовая компания редактирование"
}

Пример успешного ответа:

{
    "success":true
}

Метод getInfo

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

Параметры для запроса:
Параметры для запроса:

Параметр	Требуется	Тип	Описание
api_key	Да	string	API ключ
method	Да	string	Метод API
id	Нет	int	ID компании
order	Нет	string	Тип сортировки: DESC\|ASC (по умолчанию DESC)

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

{
    "api_key":"IW3YNXX3-05037f3f4a063596c4160d3d799413be",
    "method":"getInfo"
    "id":1
}

Пример успешного ответа:

{
    "success":true,
    "list":[
        {
            "id":1,
            "status":0,
            "status_msg":"active",
            "type":"view",
            "amount":999,
	    "amountDone":52,
            "balance":29.97,
            "id_youtube":"gFn434YBq7k",
            "title":"Тестовая компания",
            "timer":10,
            "source":0,
            "vip":0,
            "price_u":0.02,
            "price_r":0.03,
            "status_ban":false,
            "startCount": 1000,
            "texno": 0,
            "ip_user": 0,
            "user_date_reg":0 
        }
    ]
}

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

Параметр	Тип	Описание
list	array	Массив списка компаний
Параметры в массиве list
id	int	ID компании
status	int	1 - компания активная, в работе 2 - компания остановлена, не активна
status_msg	string	active - компания активная, в работе completed - компания остановлена, не активна
type	string	Тип компании: view - Просмотр видео
amount	int	Осталось выполнений компании
amountDone	int	Сколько исполнений компании уже было
balance	float	Баланс компании (в рублях)
id_youtube	string	ID видео или канала
title	string	Заголовок компании
timer	int	Таймер для типа view в секундах
source	int	Источники трафика для типа view: 0 - Скрытый источник (по умолчанию) 1 - serfclick.net
vip	int	Разместить в VIP блоке для типа view: 0 - Нет 1 - Да
price_u	float	Цена оплаты исполнителю
price_r	float	Цена оплаты за одно действие компании
status_ban	bool	Компания заблокирована true - да false - нет
startCount	int	Количества действий (view) на момент создания площадки.
texno	int	Технология просмотра для типа view: 0 - 1 раз в 24 часа 1 - 1 пользователь = 1 выполнение 2 - 1 раз в 1 час 3 - 1 раз в 3 часа 4 - 1 раз в 6 часов 5 - 1 раз в 12 часов
ip_user	int	Уникальный IP адрес для типа view: 0 - любые IP адреса 1 - только уникальные IP адреса 2 - усиленные по маске до 2 чисел (255.255.)
user_date_reg	int	Ограничение по дате регистрации: 0 - любая дата регистрации (по умолчанию) 1 - до 7 дней регистрации 2 - более 7 дней регистрации

Метод addBalance

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

Параметры для запроса:

Параметр	Требуется	Тип	Описание
api_key	Да	string	API ключ
method	Да	string	Метод API
type	Нет	string	Тип компании: view - Просмотр видео (по умолчанию)
id	Да	int	ID компании
amount	Да	int	Количество выполнений компании

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

{
    "api_key":"IW3YNXX3-05037f3f4a063596c4160d3d799413be",
    "method":"addBalance"
    "type":"view"
    "id":1
    "amount":1000
}

Пример успешного ответа:

{
    "success":true
    "balance":30.43
}

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

Параметр	Тип	Описание
balance	float	Сумма в рублях которая была внесена на баланс компании

Метод changeStatus

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

Параметры для запроса:

Параметр	Требуется	Тип	Описание
api_key	Да	string	API ключ
method	Да	string	Метод API
type	Нет	string	Тип компании: view - Просмотр видео (по умолчанию)
id	Да	int	ID компании
status	Да	int	Запустить или остановить компанию 1 - Запустить 2 - Остановить

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

{
    "api_key":"IW3YNXX3-05037f3f4a063596c4160d3d799413be",
    "method":"changeStatus"
    "type":"view"
    "id":1
    "status":1
}

Пример успешного ответа:

{
    "success":true
    "status":"active"
}

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

Параметр	Тип	Описание
status	string	Статус компании: active - компания активная, в работе completed - компания остановлена, не активна

Метод refundBalance

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

Параметры для запроса:

Параметр	Требуется	Тип	Описание
api_key	Да	string	API ключ
method	Да	string	Метод API
type	Нет	string	Тип компании: view - Просмотр видео (по умолчанию)
id	Да	int	ID компании

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

{
    "api_key":"IW3YNXX3-05037f3f4a063596c4160d3d799413be",
    "method":"refundBalance"
    "type":"view"
    "id":1
}

Пример успешного ответа:

{
    "success":true
    "balance":15.35
}

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

Параметр	Тип	Описание
balance	float	Сумма в рублях которая была возвращена на рекламный счет

Метод delete

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

Параметры для запроса:

Параметр	Требуется	Тип	Описание
api_key	Да	string	API ключ
method	Да	string	Метод API
type	Нет	string	Тип компании: view - Просмотр видео (по умолчанию)
id	Да	int	ID компании

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

{
    "api_key":"IW3YNXX3-05037f3f4a063596c4160d3d799413be",
    "method":"delete"
    "type":"view"
    "id":1
}

Пример успешного ответа:

{
    "success":true
}

НАШИ ПАРТНЕРЫ

Выплаты	Правила	Услуги	Политика	Контакты	Купить сайт	API
SERFCLICK © 2022-2024 Все права защищены