ลิงก์ - เอกสาร API

ดึงข้อมูลทั้งหมด

จุดสิ้นสุด

GET https://qr-kode.no/api/links/

ตัวอย่าง

curl --request GET \
--url 'https://qr-kode.no/api/links/' \
--header 'Authorization: Bearer {api_key}' \

พารามิเตอร์	รายละเอียด	คำอธิบาย
page	ทางเลือก จำนวนเต็ม	หมายเลขหน้าที่คุณต้องการผลลัพธ์จาก ค่าเริ่มต้นคือ `1`.
results_per_page	ทางเลือก จำนวนเต็ม	คุณต้องการผลลัพธ์กี่รายการต่อหน้า ค่าที่อนุญาตคือ: `10` , `25` , `50` , `100` , `250` , `500` , `1000` ค่าเริ่มต้นคือ `25`.

ตัวอย่างการตอบกลับ

{ "data": [ { "id": 1, "project_id": null, "domain_id": 0, "type": "link", "url": "example", "location_url": "https://example.com/", "settings": { "password": null, "sensitive_content": false }, "clicks": 10, "order": 0, "start_date": null, "end_date": null, "date": "2020-11-15 12:00:00" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://qr-kode.no/api/links?&page=1", "last": "https://qr-kode.no/api/links?&page=1", "next": null, "prev": null, "self": "https://qr-kode.no/api/links?&page=1" } }

ดึงหนึ่ง

จุดสิ้นสุด

GET https://qr-kode.no/api/links/{link_id}

ตัวอย่าง

curl --request GET \
--url 'https://qr-kode.no/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

ตัวอย่างการตอบกลับ

{ "data": { "id": 1, "project_id": null, "domain_id": 0, "type": "link", "url": "example", "location_url": "https://example.com/", "settings": { "password": null, "sensitive_content": false }, "clicks": 10, "order": 0, "start_date": null, "end_date": null, "date": "2020-11-15 12:00:00" } }

สร้าง

จุดสิ้นสุด

POST https://qr-kode.no/api/links

พารามิเตอร์	รายละเอียด	คำอธิบาย
type	ทางเลือก สตริง	`link`
location_url	จำเป็น สตริง	URL ของปลายทาง
url	ทางเลือก สตริง	อัลลิอัส URL ของลิงก์ที่สร้างขึ้น ทิ้งว่างไว้สำหรับลิงก์ที่สร้างแบบสุ่ม
domain_id	ทางเลือก จำนวนเต็ม	-
project_id	ทางเลือก จำนวนเต็ม	-
pixels_ids	ทางเลือก อาเรย์ จำนวนเต็ม	-
schedule	ทางเลือก บูลีน	-
start_date	ทางเลือก สตริง	มีให้บริการเมื่อ: schedule = true
end_date	ทางเลือก สตริง	มีให้บริการเมื่อ: schedule = true
clicks_limit	ทางเลือก จำนวนเต็ม	-
expiration_url	ทางเลือก สตริง	-
sensitive_content	ทางเลือก บูลีน	-
http_status_code	ทางเลือก จำนวนเต็ม	ค่าที่อนุญาต: `301`, `302`, `307`, `308`
app_linking_is_enabled	ทางเลือก บูลีน	-
cloaking_is_enabled	ทางเลือก บูลีน	-
cloaking_title	ทางเลือก สตริง	-
cloaking_favicon	ทางเลือก ไฟล์	-
cloaking_opengraph	ทางเลือก ไฟล์	-
password	ทางเลือก สตริง	-
forward_query_parameters_is_enabled	ทางเลือก บูลีน	-
utm_source	ทางเลือก missing_translation: api_documentation.strings	-
utm_medium	ทางเลือก missing_translation: api_documentation.strings	-
utm_campaign	ทางเลือก missing_translation: api_documentation.strings	-
targeting_type	ทางเลือก สตริง	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	ทางเลือก สตริง	(targeting_type=continent_code)
targeting_continent_code_value[index]	ทางเลือก สตริง	(targeting_type=continent_code)
targeting_country_code_key[index]	ทางเลือก สตริง	(targeting_type=country_code)
targeting_country_code_value[index]	ทางเลือก สตริง	(targeting_type=country_code)
targeting_city_name_key[index]	ทางเลือก สตริง	(targeting_type=city_name)
targeting_city_name_value[index]	ทางเลือก สตริง	(targeting_type=city_name)
targeting_device_type_key[index]	ทางเลือก สตริง	(targeting_type=device_type)
targeting_device_type_value[index]	ทางเลือก สตริง	(targeting_type=device_type)
targeting_browser_language_key[index]	ทางเลือก สตริง	(targeting_type=browser_language)
targeting_browser_language_value[index]	ทางเลือก สตริง	(targeting_type=browser_language)
targeting_rotation_key[index]	ทางเลือก สตริง	(targeting_type=rotation)
targeting_rotation_value[index]	ทางเลือก สตริง	(targeting_type=rotation)
targeting_os_name_key[index]	ทางเลือก สตริง	(targeting_type=os_name)
targeting_os_name_value[index]	ทางเลือก สตริง	(targeting_type=os_name)
targeting_browser_name_key[index]	ทางเลือก สตริง	(targeting_type=browser_name)
targeting_browser_name_value[index]	ทางเลือก สตริง	(targeting_type=browser_name)

ตัวอย่าง

curl --request POST \
--url 'https://qr-kode.no/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://qr-kode.no/' \

ตัวอย่างการตอบกลับ

{ "data": { "id": 1 } }

อัปเดต

จุดสิ้นสุด

POST https://qr-kode.no/api/links/{link_id}

พารามิเตอร์	รายละเอียด	คำอธิบาย
location_url	ทางเลือก สตริง	URL ของปลายทาง
url	ทางเลือก สตริง	อัลลิอัส URL ของลิงก์ที่สร้างขึ้น ทิ้งว่างไว้สำหรับลิงก์ที่สร้างแบบสุ่ม
domain_id	ทางเลือก จำนวนเต็ม	-
project_id	ทางเลือก จำนวนเต็ม	-
pixels_ids	ทางเลือก อาเรย์ จำนวนเต็ม	-
schedule	ทางเลือก บูลีน	-
start_date	ทางเลือก สตริง	มีให้บริการเมื่อ: schedule = true
end_date	ทางเลือก สตริง	มีให้บริการเมื่อ: schedule = true
clicks_limit	ทางเลือก จำนวนเต็ม	-
expiration_url	ทางเลือก สตริง	-
sensitive_content	ทางเลือก บูลีน	-
http_status_code	ทางเลือก จำนวนเต็ม	ค่าที่อนุญาต: `301`, `302`, `307`, `308`
app_linking_is_enabled	ทางเลือก บูลีน	-
cloaking_is_enabled	ทางเลือก บูลีน	-
cloaking_title	ทางเลือก สตริง	-
cloaking_favicon	ทางเลือก ไฟล์	-
cloaking_opengraph	ทางเลือก ไฟล์	-
password	ทางเลือก สตริง	-
forward_query_parameters_is_enabled	ทางเลือก บูลีน	-
utm_source	ทางเลือก missing_translation: api_documentation.strings	-
utm_medium	ทางเลือก missing_translation: api_documentation.strings	-
utm_campaign	ทางเลือก missing_translation: api_documentation.strings	-
targeting_type	ทางเลือก สตริง	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	ทางเลือก สตริง	(targeting_type=continent_code)
targeting_continent_code_value[index]	ทางเลือก สตริง	(targeting_type=continent_code)
targeting_country_code_key[index]	ทางเลือก สตริง	(targeting_type=country_code)
targeting_country_code_value[index]	ทางเลือก สตริง	(targeting_type=country_code)
targeting_city_name_key[index]	ทางเลือก สตริง	(targeting_type=city_name)
targeting_city_name_value[index]	ทางเลือก สตริง	(targeting_type=city_name)
targeting_device_type_key[index]	ทางเลือก สตริง	(targeting_type=device_type)
targeting_device_type_value[index]	ทางเลือก สตริง	(targeting_type=device_type)
targeting_browser_language_key[index]	ทางเลือก สตริง	(targeting_type=browser_language)
targeting_browser_language_value[index]	ทางเลือก สตริง	(targeting_type=browser_language)
targeting_rotation_key[index]	ทางเลือก สตริง	(targeting_type=rotation)
targeting_rotation_value[index]	ทางเลือก สตริง	(targeting_type=rotation)
targeting_os_name_key[index]	ทางเลือก สตริง	(targeting_type=os_name)
targeting_os_name_value[index]	ทางเลือก สตริง	(targeting_type=os_name)
targeting_browser_name_key[index]	ทางเลือก สตริง	(targeting_type=browser_name)
targeting_browser_name_value[index]	ทางเลือก สตริง	(targeting_type=browser_name)

ตัวอย่าง

curl --request POST \
--url 'https://qr-kode.no/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

ตัวอย่างการตอบกลับ

{ "data": { "id": 1 } }

ลบ

จุดสิ้นสุด

DELETE https://qr-kode.no/api/links/{link_id}

ตัวอย่าง

curl --request DELETE \
--url 'https://qr-kode.no/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \