Za pomocą tego interfejsu API można wyświetlać, dodawać, edytować i usuwać znaczniki w projekcie.
Przeczytaj.
Umożliwia wyświetlenie utworzonych znaczników w projekcie.
GET https://api.smartsender.com/v1/tags
Parametry podstawowe:
Tytuł | Opis | Walidacja |
|---|---|---|
page | Żądana strona | Wartość minimalna 1 |
limitation | Ilość danych, które mają być wyświetlane na stronie | Wartość minimalna 1, wartość maksymalna 20 |
term | Ciąg wyszukiwania |
|
Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje
{
"cursor": Cursor,
"collection": Tag[]
}
Parametry podstawowe:
Tytuł | Opis |
|---|---|
cursor | Cursor obiekt |
collection | Tablica obiektów Tag |
Stworzenie.
Umożliwia utworzenie znacznika w projekcie.
POST https://api.smartsender.com/v1/tags
Parametry podstawowe:
Tytuł | Opis | Walidacja |
|---|---|---|
name | Nazwa | Unikalność w ramach projektu |
color | Kolor | 6 znaków dla oznaczenia HEX |
Jeśli się powiedzie, otrzymasz informację o utworzonym obiekcie Tag.
Aktualizacja.
Umożliwia aktualizację istniejącego znacznika.
PUT https://api.smartsender.com/v1/tags/{tagId}
Parametry podstawowe:
Tytuł | Opis | Walidacja |
|---|---|---|
name | Nazwa | Unikalność w ramach projektu |
color | Kolor | 6 znaków dla oznaczenia HEX |
Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje
{
"state": true
}
Usuń.
Umożliwia usunięcie istniejącego znacznika.
DELETE https://api.smartsender.com/v1/tags/{tagId}
Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje
{
"state": true
}