Variables API

С помощью данного API вы можете просматривать, добавлять, редактировать и удалять переменные в проекте.

Чтение.

Позволяет просмотреть созданные переменные в проекте.

 

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

 

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

Название

Описание

Валидация

Название

Описание

Валидация

page

Запрашиваемая страница

Минимальное значение 1

limitation

Количество данных для вывода на странице

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

term

Строка для поиска

 

 

В случае успешного ответа получите следующее:

 

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

 

Описание ответа:

Название

Описание

Название

Описание

cursor

Cursor обьект

collection

Массив Variable объектов

 

Создание.

Позволяет создать новую переменную в проекте.

 

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

 

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

Название

Описание

Валидация

Название

Описание

Валидация

name

Название

Уникальный в рамках проекта

type

Тип

Доступные

  • url

  • date

  • enum

  • email

  • phone

  • number

  • string

description

Описание

Обязательно

values

Варианты выбора через запятую

Обязательно если тип enum

 

В случае успешного ответа получите созданный Variable объект.



Обновление.

Позволяет обновить существующую переменную.

 

 

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

Название

Описание

Название

Описание

name

Название

description

Описание

 

В случае успешного ответа получите следующее:

 

 


Удаление.

Позволяет удалить существующую переменную.

 

 

В случае успешного ответа получите следующее: