API
RibLink.ru 提供统一的编程接口，用于与系统组件进行交互。
发送到 RibLink.ru API 的请求，是通过传递 POST 或 GET 参数、发起请求所对应用户的 ID（参数 user_id），以及密钥（参数 skey）来完成的。该密钥是通过将按键排序后的参数（使用符号 ":" 拼接）结合用户的秘密密钥，使用 sha256 方法加密生成的。PHP 中生成 API 密钥的示例如下：hash_hmac('sha256', implode(':', $params), {Ваш API ключ из панели управления}, false)
您的用户 ID： 登录后查看
您的 API 密钥： 登录后查看
您的 API 密钥： 登录后查看
根据您希望接收响应的语言 (en, ru, de, fr, es, zh, hi) 以及格式（JSON 或 XML），请求链接的格式也会相应确定。
https://api.riblink.ru/{язык}/request/{формат}/{операция}
示例：https://api.riblink.ruzh/request/json/campaigns/create
示例：https://api.riblink.ruzh/request/json/campaigns/create
为了避免为所有同类型响应重复创建记录，本指南将重点介绍如何使用您的语言 zh 以及最简单的数据描述格式 - JSON - 来操作 API。
API 返回的响应有两种类型：
1. 操作成功：{result: true, data: ... }
2. 错误：{result: false, data: "错误描述"}，或 {result: false, data: {"param1" => "错误描述", "param2" => "错误描述2", ...}}
请注意，通过 API 获取的所有日期和时间，均以发起请求用户的时区显示。用户的时区可在设置中修改。
您也可以使用现成方案，并下载带示例的 PHP API 客户端。
操作
说明：必填项以 蓝色 标出.
创建广告系列 / 更新广告系列数据
https://api.riblink.ru/zh/request/json/campaigns/create如果未传递 campaign_id，则创建新的广告系列；如果已传递，则更新广告系列数据。返回已创建/已更新广告系列的数据
参数:
- title - 广告系列名称
- campaign_id - 如果您想更新 ранее 创建的广告系列数据，请填写广告系列 ID
- links_type - 链接类型：0 - 仅键值（默认），1 - 键值和链接片段
- ads_type - 广告类型：0 - 关闭，1 - 加载页（默认）
- ads_popunder - 启用 popunder/clickunder (默认开启)
- 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://rib1.ru",
"public_stat": 0,
"urls_amount": 0,
"created": "2017-09-15 20:38:54"
}
}
获取广告系列数据
https://api.riblink.ru/zh/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://rib1.ru",
"public_stat": 0,
"urls_amount": 0,
"created": "2017-09-15 20:38:54"
}
}
创建链接 / 更新链接数据
https://api.riblink.ru/zh/request/json/campaigns/links/create如果未传递 link_id，则创建新链接；如果已传递，则更新现有链接数据。返回已创建/已更新链接的数据
参数:
- url - 需要缩短/转换的链接
- link_id - 如果您想更新现有链接数据，请填写链接 ID
- campaign_id - 要添加到的广告系列 ID（仅在创建新链接时）。如果未指定，则链接将被添加到 默认广告系列
- url_key - 链接键值（短链接结尾部分）。如果未指定，将随机创建
- title - 链接名称
- description - 链接描述
- button - 跳转按钮文案
- comment - 链接备注（仅自己可见）
响应示例:
{
"result": true
}
获取链接数据
https://api.riblink.ru/zh/request/json/campaigns/links/get按 link_id 或 url_key 查找链接并返回其数据。仅显示您自己的链接数据。
参数:
- 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"
}
}