Списки

Данное API позволяет создавать произвольные списки и проводить различные операции над ними, которые возможно привязывать к пользователю или к боту.

Схема списка

Как правильно сформировать запрос?! Смотрим в основах

Получить списки (схемы)

GET https://app.cleverapp.pro/api/v1/getListSchemas

Этот метод позволяет получить списки (схемы).

200: OK Запрос успешно обработан

{
  "data": [
    {
      "id": "5dee4800c2cc5a38ec797235",
      "fields": {
        "name": {
          "name": "Название",
          "type": "string",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "quantity": {
          "name": "Количество",
          "type": "number",
          "is_required": false,
          "is_hidden": false,
          "is_encryptable": false
        },
        "is_vip": {
          "name": "VIP",
          "type": "bool",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "contact": {
          "name": "Контакт",
          "type": "contact",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "key": {
          "name": "Ключ",
          "type": "string",
          "is_required": true,
          "is_hidden": true,
          "is_encryptable": true
        }
      },
      "name": "Заказы",
      "is_menu": false,
      "created_at": "2019-12-09T13:11:28+00:00",
      "updated_at": "2019-12-09T13:11:28+00:00"
    }
  ],
  "links": {
    "first": "https:\/\/watbot.ru\/api\/v1\/getListSchemas?page=1",
    "last": "https:\/\/watbot.ru\/api\/v1\/getListSchemas?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https:\/\/watbot.ru\/api\/v1\/getListSchemas",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}

Получить список (схему)

GET https://app.cleverapp.pro/api/v1/getListSchemas

Этот метод позволяет получить списки (схемы).

200: OK Запрос успешно обработан

{
  "data": {
    "id": "5dee4800c2cc5a38ec797235",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      }
    },
    "name": "Заказы",
    "is_menu": false,
    "created_at": "2019-12-09T13:11:28+00:00",
    "updated_at": "2019-12-09T13:11:28+00:00"
  }
}

Создать список (схему)

POST https://app.cleverapp.pro/api/v1/createListSchema

Этот метод позволяет создать список.

Request Body

Name	Type	Description
is_menu	boolean	Отображать ссылку на список в меню в интерфейсе CleverApp
name*	string	Название списка.
bot_id	integer	ID бота, если вы хотите привязать список к боту.
fields*	object	name string - название поля slug string - уникальная строка поля type string - тип поля (string, number, boolean, contact, bot) - см. ниже. is_required boolean - обязательность заполнения поля is_hidden boolean - скрыть поле из интерфейса? is_encryptable boolean - шифровать поле для хранения в БД? По таким поля нельзя делать фильтрацию и сортировку.

200: OK Запрос успешно обработан

{
  "data": {
    "id": "5dee51518a7ab32ecf060265",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      }
    },
    "name": "Заказы",
    "is_menu": true,
    "created_at": "2019-12-09T13:51:13+00:00",
    "updated_at": "2019-12-09T13:51:13+00:00"
  }
}

422: Unprocessable Entity Переданы некорректные данные

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "Поле Имя обязательно для заполнения."
    ],
    "fields": [
      "Поле fields обязательно для заполнения."
    ]
  }
}

Типы поля fields["type"]

Тип	Значение
string	строка/текст
number	число
boolean	логический тип
contact	id контакта
bot	id бота

Добавить новое поле в список (схему)

POST https://app.cleverapp.pro/api/v1/addListSchemaField

Этот метод позволяет добавить новое поле в список.

Request Body

Name	Type	Description
field*	object	Смотрите метод createListSchema поле fields. Укажите только те поля, которые хотите обновить.
schema_id*	string	ID списка.

201: Created Запрос успешно обработан

{
    // Response
}

Если в списке есть уже элементы, то созданное поле заполнится для них значением null

Удалить поле списка (схемы)

POST https://app.cleverapp.pro/api/v1/deleteListSchemaField

Этот метод позволяет удалить поле списка.

Request Body

Name	Type	Description
slug*	string	Slug поля.
schema_id*	string	ID списка.

204: No Content Запрос успешно обработан

{
    // Response
}

Удалить список (схему)

POST https://app.cleverapp.pro/api/v1/deleteListSchema

Этот метод позволяет удалить список.

Request Body

Name	Type	Description
schema_id*	string	ID списка.

204: No Content Запрос успешно обработан

{
    // Response
}