Пространства - Разработчикам

Заметки

Уровень эксперта

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

Список

API-эндпоинт:

GET

https://url-click.ru/api/v1/spaces

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

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

Параметр

Тип

Описание

search

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

Поисковый запрос.

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-эндпоинт:

GET

https://url-click.ru/api/v1/spaces/{id}

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

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

Сохранить

API-эндпоинт:

POST

https://url-click.ru/api/v1/spaces

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

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

Параметр

Тип

Описание

name

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

Название пространства.

color

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

Код цвета. Возможные значения: 1, 2, 3, 4, 5, 6. По умолчанию: 1.

Обновить

API-эндпоинт:

PUT PATCH

https://url-click.ru/api/v1/spaces/{id}

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

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

Параметр

Тип

Описание

name

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

Название пространства.

color

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

Код цвета. Возможные значения: 1, 2, 3, 4, 5, 6.

Удалить

API-эндпоинт:

DELETE

https://url-click.ru/api/v1/spaces/{id}

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

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