Метки - API - TinyLinks

Примечания

Expert level

Ключ API должен быть отправлен как Bearer token в заголовке авторизации запроса. Получите ваш ключ API.

Список

API endpoint:

GET

https://tinylinks.ru/api/v1/spaces

Пример запроса:

curl --location --request GET 'https://tinylinks.ru/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

search

необязательный string

The search query.

search_by

необязательный string

Поиск по. Возможные значения: name для Имя. По умолчанию: name.

sort_by

необязательный string

Сортировать по. Возможные значения: id для Дата создания, name для Имя. По умолчанию: id.

sort

необязательный string

Сортировать. Возможные значения: desc для По убыванию, asc для По возрастанию. По умолчанию: desc.

per_page

необязательный integer

Результатов на странице. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.

Показать

API endpoint:

GET

https://tinylinks.ru/api/v1/spaces/{id}

Пример запроса:

curl --location --request GET 'https://tinylinks.ru/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Добавить

API endpoint:

POST

https://tinylinks.ru/api/v1/spaces

Пример запроса:

curl --location --request POST 'https://tinylinks.ru/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'

Параметр

Тип

Описание

name

обязательный string

The space name.

color

необязательный integer

The color code. Возможные значения: 1, 2, 3, 4, 5, 6. По умолчанию: 1.

Обновить

API endpoint:

PUT PATCH

https://tinylinks.ru/api/v1/spaces/{id}

Пример запроса:

curl --location --request PUT 'https://tinylinks.ru/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

name

необязательный string

The space name.

color

необязательный integer

The color code. Возможные значения: 1, 2, 3, 4, 5, 6.

Удалить

API endpoint:

DELETE

https://tinylinks.ru/api/v1/spaces/{id}

Пример запроса:

curl --location --request DELETE 'https://tinylinks.ru/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'