Сілтемелер - API құжаттамасы

Барлығын алу

Соңғы нүкте

GET https://taplanding.com/api/links/

Мысал

curl --request GET \
--url 'https://taplanding.com/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://taplanding.com/api/links?&page=1", "last": "https://taplanding.com/api/links?&page=1", "next": null, "prev": null, "self": "https://taplanding.com/api/links?&page=1" } }

Біреуін алыңыз

Соңғы нүкте

GET https://taplanding.com/api/links/{link_id}

Мысал

curl --request GET \
--url 'https://taplanding.com/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://taplanding.com/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	Міндетті емес Файл	-
password	Міндетті емес Жолақ	-
targeting_type	Міндетті емес Жолақ	`country_code` , `device_type` , `browser_language` , `rotation` , `os_name`
targeting_country_code_key[index]	Міндетті емес Жолақ	(targeting_type=country_code)
targeting_country_code_value[index]	Міндетті емес Жолақ	(targeting_type=country_code)
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)

Мысал

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

Жауап мысалы

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

Жаңарту

Соңғы нүкте

POST https://taplanding.com/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	Міндетті емес Файл	-
password	Міндетті емес Жолақ	-
targeting_type	Міндетті емес Жолақ	`country_code` , `device_type` , `browser_language` , `rotation` , `os_name`
targeting_country_code_key[index]	Міндетті емес Жолақ	(targeting_type=country_code)
targeting_country_code_value[index]	Міндетті емес Жолақ	(targeting_type=country_code)
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)

Мысал

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

Жауап мысалы

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

Жою

Соңғы нүкте

DELETE https://taplanding.com/api/links/{link_id}

Мысал

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