Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

За допомогою цього API ви можете переглядати, додавати, редагувати та видаляти змінні в проекті.

Читання.

Дозволяє переглянути створені змінні у проекті.

 

Code Block
GET https://api.smartsender.com/v1/variables

 

Основні параметри:

Назва

Опис

Валідація

page

Запрошувана сторінка

Мінімальне значення 1

limitation

Кількість даних для виводу на сторінці

Мінімальне значення 1, максимальне 20

term

Рядок для пошуку

 

 

У разі успішної відповіді отримаєте таке:

 

Code Block
{
    "cursor": Cursor,
    "collection": Variable[]
}

 

Опис відповіді:

Назва

Опис

cursor

Об'єкт типу Cursor

collection

Масив Variable об'єктів

 

Створeння.

Дозволяє створити нову змінну у проекті.

Code Block
POST https://api.smartsender.com/v1/variables

 

Основні параметри:

Назва

Опис

Валідація

name

Назва

Унікальний у рамках проекту

type

Тип

Доступні

  • url

  • date

  • enum

  • email

  • phone

  • number

  • string

description

Опи

Обов'язково

values

Варіанти вибору через кому

Обов'язково якщо тип enum

 

У разі успішної відповіді отримаєте створений Variable об'єкт.

Оновлення.

Дозволяє оновити існуючу змінну.

 

Code Block
PUT https://api.smartsender.com/v1/variables/{variableId}

 

Основні параметри:

Назва

Опис

name

Назва

description

Опис

 

У разі успішної відповіді отримаєте таке:

 

Code Block
{
    "state": true
}

 


Видалення.

Дозволяє видалити існуючу змінну.

 

Code Block
DELETE https://api.smartsender.com/v1/variables/{variableId}

 

У разі успішної відповіді отримаєте таке:

 

Code Block
{
    "state": true
}