Группы - Разработчикам

Заметки

Экспертный уровень

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

Список

API эндпоинт:

GET

http://link.sending.digital/api/v1/spaces

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

curl --location --request GET 'http://link.sending.digital/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

search

опционально string

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

sort

опционально string

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

per_page

опционально int

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

Показать

API эндпоинт:

GET

http://link.sending.digital/api/v1/spaces/{id}

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

curl --location --request GET 'http://link.sending.digital/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Записать

API эндпоинт:

POST

http://link.sending.digital/api/v1/spaces

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

curl --location --request POST 'http://link.sending.digital/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

Параметр

Тип

Описание

name

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

Название группы.

color

опционально integer

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

Обновить

API эндпоинт:

PUT PATCH

http://link.sending.digital/api/v1/spaces/{id}

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

curl --location --request PUT 'http://link.sending.digital/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

Параметр

Тип

Описание

name

опционально string

Название группы.

color

опционально integer

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

Удалить

API эндпоинт:

DELETE

http://link.sending.digital/spaces/{id}/destroy

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

curl --location --request DELETE 'http://link.sending.digital/spaces/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'