Ссылки – документация по API

Извлечь все

Конечная точка

GET https://biopage.ru/api/links/

Пример

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

Извлечь один

Конечная точка

GET https://biopage.ru/api/links/{link_id}

Пример

curl --request GET \
--url 'https://biopage.ru/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://biopage.ru/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://biopage.ru/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://biopage.ru/' \

Пример ответа

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

Обновить

Конечная точка

POST https://biopage.ru/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://biopage.ru/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Пример ответа

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

Удалить

Конечная точка

DELETE https://biopage.ru/api/links/{link_id}

Пример

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