Пространства

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

API-точка входа:

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

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

curl --location --request GET 'https://nnm.by/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
необязательное int
Результатов на страницу. Допустимые значения: 10, 25, 50, 100. По умолчанию: 10.
Показать

API-точка входа:

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

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

curl --location --request GET 'https://nnm.by/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Сохранить

API-точка входа:

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

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

curl --location --request POST 'https://nnm.by/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://nnm.by/api/v1/spaces/{id}

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

curl --location --request PUT 'https://nnm.by/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://nnm.by/api/v1/spaces/{id}

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

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