APIドキュメント
リンク
短縮リンク、ターゲティングルール、ピクセル、リダイレクトを作成および管理します。
認証
すべてのリクエストは、管理APIキーに一致するBearerトークンをAuthorizationヘッダーで送信する必要があります。
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.整数
|
1ページあたりに取得したい結果の数。許可される値は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レスポンス本文。