API 文档
链接
创建和管理您的短链接、目标规则、像素和重定向。
身份验证
每个请求都必须在 Authorization 头中发送与管理员 API 密钥匹配的 Bearer 令牌。
获取API密钥.
端点
GET https://rqrcode.com/api/links/
示例
curl --request GET \
--url 'https://rqrcode.com/api/links/' \
--header 'Authorization: Bearer {api_key}'
参数
| 参数 | 详情 | 描述 |
|---|---|---|
| page |
可选
ui.admin.api_docs.common.types.整数
|
您想要获取结果的页码。默认为1。 |
| results_per_page |
可选
ui.admin.api_docs.common.types.整数
|
每页您想要的结果数量。允许值为：10, 25, 50, 100, 250, 500, 1000。默认为25。 |
响应示例
{
"data": [
{
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "示例",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"pageviews": 10,
"order": 0,
"start_date": null,
"end_date": null,
"datetime": "2026-04-20 07:53:23"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/links?page=1",
"last": "https://rqrcode.com/api/links?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/links?page=1"
}
}
端点
GET https://rqrcode.com/api/links/{link_id}
示例
curl --request GET \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
参数
无附加参数。
响应示例
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "示例",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"pageviews": 10,
"order": 0,
"start_date": null,
"end_date": null,
"datetime": "2026-04-20 07:53:23"
}
}
端点
POST https://rqrcode.com/api/links
示例
curl --request POST \
--url 'https://rqrcode.com/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=示例' \
--form 'location_url=https://rqrcode.com/'
参数
| 参数 | 详情 | 描述 |
|---|---|---|
| location_url |
必填
ui.admin.api_docs.common.types.字符串
|
目标URL。可用条件：is_bulk = 0 |
| location_urls |
必填
ui.admin.api_docs.common.types.字符串
|
目标URL。可用条件：is_bulk = 1 |
| url |
可选
ui.admin.api_docs.common.types.字符串
|
生成的URL别名。留空则随机生成。可用条件：is_bulk = 0 |
| is_bulk |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| domain_id |
可选
ui.admin.api_docs.common.types.整数
|
— |
| project_id |
可选
ui.admin.api_docs.common.types.整数
|
— |
| pixels_ids |
可选
ui.admin.api_docs.common.types.整数
|
— |
| schedule |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| start_date |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：schedule = true |
| end_date |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：schedule = true |
| pageviews_limit |
可选
ui.admin.api_docs.common.types.整数
|
— |
| expiration_url |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| password |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| forward_query_parameters_is_enabled |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| utm_source |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| utm_medium |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| utm_campaign |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| sensitive_content |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| http_status_code |
可选
ui.admin.api_docs.common.types.整数
|
允许值：301, 302, 307, 308 |
| app_linking_is_enabled |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| cloaking_is_enabled |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| cloaking_title |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| cloaking_meta_description |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| cloaking_custom_js |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| cloaking_favicon |
可选
ui.admin.api_docs.common.types.文件
|
— |
| cloaking_opengraph |
可选
ui.admin.api_docs.common.types.文件
|
— |
| targeting_type |
可选
ui.admin.api_docs.common.types.字符串
|
允许值：continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = continent_code |
| targeting_continent_code_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = continent_code |
| targeting_country_code_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = country_code |
| targeting_country_code_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = country_code |
| targeting_city_name_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = city_name |
| targeting_city_name_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = city_name |
| targeting_device_type_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = device_type |
| targeting_device_type_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = device_type |
| targeting_browser_language_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = browser_language |
| targeting_browser_language_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = browser_language |
| targeting_rotation_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = rotation |
| targeting_rotation_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = rotation |
| targeting_os_name_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = os_name |
| targeting_os_name_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = os_name |
| targeting_browser_name_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = browser_name |
| targeting_browser_name_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = browser_name |
响应示例
{
"data": {
"id": 1
}
}
端点
POST https://rqrcode.com/api/links/{link_id}
示例
curl --request POST \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0'
参数
| 参数 | 详情 | 描述 |
|---|---|---|
| location_url |
可选
ui.admin.api_docs.common.types.字符串
|
目标URL。 |
| url |
可选
ui.admin.api_docs.common.types.字符串
|
生成的URL别名。留空则随机生成。 |
| domain_id |
可选
ui.admin.api_docs.common.types.整数
|
— |
| project_id |
可选
ui.admin.api_docs.common.types.整数
|
— |
| pixels_ids |
可选
ui.admin.api_docs.common.types.整数
|
— |
| schedule |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| start_date |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：schedule = true |
| end_date |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：schedule = true |
| pageviews_limit |
可选
ui.admin.api_docs.common.types.整数
|
— |
| expiration_url |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| password |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| forward_query_parameters_is_enabled |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| utm_source |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| utm_medium |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| utm_campaign |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| sensitive_content |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| http_status_code |
可选
ui.admin.api_docs.common.types.整数
|
允许值：301, 302, 307, 308 |
| app_linking_is_enabled |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| cloaking_is_enabled |
可选
ui.admin.api_docs.common.types.布尔值
|
— |
| cloaking_title |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| cloaking_meta_description |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| cloaking_custom_js |
可选
ui.admin.api_docs.common.types.字符串
|
— |
| cloaking_favicon |
可选
ui.admin.api_docs.common.types.文件
|
— |
| cloaking_opengraph |
可选
ui.admin.api_docs.common.types.文件
|
— |
| targeting_type |
可选
ui.admin.api_docs.common.types.字符串
|
允许值：continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = continent_code |
| targeting_continent_code_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = continent_code |
| targeting_country_code_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = country_code |
| targeting_country_code_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = country_code |
| targeting_city_name_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = city_name |
| targeting_city_name_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = city_name |
| targeting_device_type_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = device_type |
| targeting_device_type_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = device_type |
| targeting_browser_language_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = browser_language |
| targeting_browser_language_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = browser_language |
| targeting_rotation_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = rotation |
| targeting_rotation_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = rotation |
| targeting_os_name_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = os_name |
| targeting_os_name_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = os_name |
| targeting_browser_name_key[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = browser_name |
| targeting_browser_name_value[index] |
可选
ui.admin.api_docs.common.types.字符串
|
可用条件：targeting_type = browser_name |
响应示例
{
"data": {
"id": 1
}
}
端点
DELETE https://rqrcode.com/api/links/{link_id}
示例
curl --request DELETE \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
参数
无附加参数。
响应示例
成功时返回空的 200 响应体。