Созвездия

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

API запрос:

GET 
https://clik.by/api/v1/spaces

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

curl --location --request GET 'https://clik.by/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
optional string
Поисковый запрос.
search_by
optional string
Поиск по. Возможные значения: name для Имя. Дефолтные: name.
sort_by
optional string
Сортировать по. Возможные значения: id для Дата создания, name для Имя. Дефолтные: id.
sort
optional string
Сортировка. Возможные значения: desc для По убыванию, asc для По возрастанию. Дефолтные: desc.
per_page
optional integer
Результатов на страницу. Возможные значения: 10, 25, 50, 100. Дефолтные: 10.
Показать

API запрос:

GET 
https://clik.by/api/v1/spaces/{id}

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

curl --location --request GET 'https://clik.by/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Получить

API запрос:

POST 
https://clik.by/api/v1/spaces

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

curl --location --request POST 'https://clik.by/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
optional integer
The color code. Возможные значения: 1, 2, 3, 4, 5, 6. Дефолтные: 1.
Обновить

API запрос:

PUT PATCH 
https://clik.by/api/v1/spaces/{id}

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

curl --location --request PUT 'https://clik.by/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
name
optional string
The space name.
color
optional integer
The color code. Возможные значения: 1, 2, 3, 4, 5, 6.
Удалить

API запрос:

DELETE 
https://clik.by/api/v1/spaces/{id}

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

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