Групи

Бележки
Експертно ниво
API ключът трябва да бъде изпратен като Bearer token в Authorization header на заявката. Вземете вашия API ключ.
Списък

API крайна точка:

GET 
https://short.bg/api/v1/spaces

Примерна заявка: 

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

API крайна точка:

GET 
https://short.bg/api/v1/spaces/{id}

Примерна заявка: 

curl --location --request GET 'https://short.bg/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Запази

API крайна точка:

POST 
https://short.bg/api/v1/spaces

Примерна заявка: 

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

Примерна заявка: 

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

Примерна заявка: 

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