API
riblink.ru предоставляет единый программный интерфейс для взаимодействия с компонентами системы.
Запрос, отправляемый на API riblink.ru, осуществляется посредством передачи POST или GET параметров, ID пользователя (параметр user_id), от имени которого осуществляется запрос, а также ключа (параметр skey), который формируется посредством шифрования отсортированных по ключу параметров ("склеенных" посредством символа ":") методом sha256 и секретного ключа пользователя. Формирование ключа API на PHP выглядит следующим образом: hash_hmac('sha256', implode(':', $params), {Ваш API ключ из панели управления}, false)
Ваш ключ для API: войдите в систему для просмотра
В зависимости от того, на каком языке (en, ru) и в каком формате Вы желаете получить ответ (JSON или XML), устанавливается формат ссылки запроса.
Пример: https://api.riblink.com/ru/request/json/campaigns/create
Чтобы не дублировать записи для всех однотипных вариантов ответа, данное руководство будет сосредоточено на описании работы с API, с использованием Вашего языка ru и посредством наиболее простого формата описания данных - JSON.
Ответ, получаемый от API, бывает двух типов:
1. Успех операции: {result: true, data: ... }
2. Ошибка: {result: false, data: "описание ошибки"}, либо {result: false, data: {"param1" => "описание ошибки", "param2" => "описание ошибки2", ...}}
Обратите внимание, что все даты и время, которые вы получите посредством обращения к API - указываются в часовом поясе пользователя, от имени которого совершается запрос. Часовой пояс пользователя можно изменить в Настройках.
Вы можете воспользоваться готовым решением и скачать клиент взаимодействия с API на PHP с примерами.
Операции
Примечание: обязательные выделены синим.
Создание кампании / Обновление данных кампании
https://api.riblink.ru/ru/request/json/campaigns/createПараметры:
- title - Название кампании
- campaign_id - ID кампании, если Вы хотите обновить данные ранее созданной кампании
- links_type - Тип ссылок: 0 - только ключ (по-умолчанию) 1 - ключ и часть ссылки
- ads_type - Тип рекламы: 0 - отключено, 1 - страница загрузки (по-умолчанию)
- ads_popunder - Подключить попандер/кликандер (по-умолчанию включено)
- ads_adult - Допускать рекламу для взрослых (adult) (по-умолчанию отключено)
- ads_interval - Интервал показа рекламы одному и тому же человеку (сек.): 0 - без ограничений (по-умолчанию), 3600 - раз в час, 86400 - раз в сутки
- show_dest_url - Показывать пользователю конечную ссылку перехода (по-умолчанию отключено)
- links_title - Заголовок для всех ссылок
- links_description - Описание для всех ссылок
- links_button - Надпись на кнопке перехода
- public_stat - Общедоступная статистика на ссылках
- password - Пароль для ссылок
- password_confirm - Повторите пароль
- domain_id - ID домена, который Вы ранее подключили. Все ссылки кампании будут использовать этот домен
Пример ответа:
{
"result": true,
"data": {
"id": 521,
"title": "My new campaign",
"type": "manual",
"status": "active",
"ads_type": 0,
"ads_popunder": 1,
"ads_adult": 0,
"ads_interval": 0,
"links_type": 0,
"show_dest_url": 0,
"links_title": "",
"links_description": "",
"links_button": "",
"has_links_password": true,
"domain": "https://rib.ink",
"public_stat": 0,
"urls_amount": 0,
"created": "2017-09-15 20:38:54"
}
}
Получение данных кампании
https://api.riblink.ru/ru/request/json/campaigns/getПараметры:
- campaign_id - ID кампании
Пример ответа:
{
"result": true,
"data": {
"id": 521,
"title": "My new campaign",
"type": "manual",
"status": "active",
"ads_type": 0,
"ads_popunder": 1,
"ads_adult": 0,
"ads_interval": 0,
"links_type": 0,
"show_dest_url": 0,
"links_title": "",
"links_description": "",
"links_button": "",
"has_links_password": true,
"domain": "https://rib.ink",
"public_stat": 0,
"urls_amount": 0,
"created": "2017-09-15 20:38:54"
}
}
Создание ссылки / Обновление данных ссылки
https://api.riblink.ru/ru/request/json/campaigns/links/createПараметры:
- url - Ссылка, которую необходимо сократить/преобразовать
- link_id - ID ссылки, если Вы хотите обновить данные существующей ссылки
- campaign_id - ID кампании, в которую будет добавлена ссылка (только при создании новой). Если не указано - ссылка будет добавлена в кампанию по-умолчанию
- url_key - Ключ ссылки (на что заканчивается короткая ссылка). Если не указан, будет создан случайный
- title - Название ссылки
- description - Описание ссылки
- button - Надпись на кнопке перехода
- comment - Комментарий к ссылке (видите только вы)
Пример ответа:
{
"result": true
}
Получение данных ссылки
https://api.riblink.ru/ru/request/json/campaigns/links/getПараметры:
- link_id - ID ссылки
- url_key - Ключ ссылки (на что заканчивается короткая ссылка)
Пример ответа:
{
"result": true,
"data": {
"id": 36523,
"campaign_id": 521,
"campaign_title": "My new campaign",
"url_key": "bx5i",
"url": "https://riblink.ru/index/rules",
"title": "",
"description": "",
"button": "",
"comment": "",
"created": "2017-09-16 13:23:24"
}
}