API справочники
- API бренды (Brand)
- API группы контактов (User group)
- API документов (Document)
- API заказы (Orders)
- API категории (Category)
- API отправка SMS или Email
- API платежи (Payment)
- API получение Бизнес процессов и статусов
- API получения пользователя по номеру телефона
- API пользователи (User)
- API склады (Storage)
- API создание звонков
- API справочники
- API товары (Product)
- API цены товаров (Product price)
- Инструкция создать пользователя и пароль API
- Песочница (Sandbox) REST API
Добавление одной записи в справочник, метод: /api/directory/change/?actiontype=insert
Параметры
Пример:
http://myboxurl/api/directory/change/?login=XXXX&password=YYY&actiontype=insert&directoryid=1&field1=value1&field2=value2
| № | Поле | Тип | Описание | Обязательное или нет | Коментарий |
| 1 | login | string | Логин в системе BOX | Обязательное поле. | |
| 2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
| 3 | directoryid | integer | id справочника | Обязательное поле. | |
| 4 | [KEY] | string | поля справочника | Для вставки необходимых параметров передавайте в формате КЛЮЧ=ЗНАЧЕНИЕ, где КЛЮЧ - это идентификатор требуемого поля | |
| 5 | dataFromBody | boolean | Брать данные не из аргументов, а из body | Не обязательное поле. | Если передан dataFromBody=1, то данные будут братся не из аргументов, а из тела запроса. В тело должен быть передан json, в котором ключами должны быть параметры, описанные выше. login и password пи этом должны посылатся как обычно |
Редактирование одной записи в справочнике, метод: /api/directory/change/?actiontype=update
Параметры
Пример:
http://myboxurl/api/directory/change/?login=XXXX&password=YYY&actiontype=update&directoryid=1&id=1&field2=value2&data[field1]=value1&data[field2]=value2
| № | Поле | Тип | Описание | Обязательное или нет | Коментарий |
| 1 | login | string | Логин в системе BOX | Обязательное поле. | |
| 2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
| 3 | directoryid | integer | id справочника | Обязательное поле. | |
| 5 | data | array | поля справочника для обновления | Ассоциативный массив значений для редактрование справочника. Массив содержит значения в формате КЛЮЧ=ЗНАЧЕНИЕ, где КЛЮЧ - это идентификатор требуемого поля | |
| 6 | id или recordid | integer | id записи справочника | Не обязательное поле. | Если желаете изменить конкретную запись справочника |
| 7 | [KEY] | string | поля справочника | Для поиска необходимой записи на редактирование можно передавать значение в формате КЛЮЧ=ЗНАЧЕНИЕ, где КЛЮЧ - это идентификатор требуемого поля | |
| 8 | dataFromBody | boolean | Брать данные не из аргументов, а из body | Не обязательное поле. | Если передан dataFromBody=1, то данные будут братся не из аргументов, а из тела запроса. В тело должен быть передан json, в котором ключами должны быть параметры, описанные выше. login и password пи этом должны посылатся как обычно |
Удаление записи в справочнике, метод: /api/directory/change/?actiontype=delete
Параметры
Пример:
http://myboxurl/api/directory/get/?login=XXXX&password=YYY&directoryid=1
| № | Поле | Тип | Описание | Обязательное или нет | Коментарий |
| 1 | login | string | Логин в системе BOX | Обязательное поле. | |
| 2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
| 3 | directoryid | integer | id справочника | Обязательное поле. | |
| 6 | recordid | integer | id записи справочника | Не обязательное поле. | |
| 7 | dataFromBody | boolean | Брать данные не из аргументов, а из body | Не обязательное поле. | Если передан dataFromBody=1, то данные будут братся не из аргументов, а из тела запроса. В тело должен быть передан json, в котором ключами должны быть параметры, описанные выше. login и password пи этом должны посылатся как обычно |
Добавление нескольких записей в справочник, метод: /api/directory/change/?actiontype=insert
Параметры
Пример:
http://myboxurl/api/directory/change/?login=XXXX&password=YYY&actiontype=insert&directoryid=1&massivechange=[{"field1":"val1","field2":"val2","field3":"val3"},{"field1":"val11","field2":"val22","field3":"val33"}]
| № | Поле | Тип | Описание | Обязательное или нет | Коментарий |
| 1 | login | string | Логин в системе BOX | Обязательное поле. | |
| 2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
| 3 | directoryid | integer | id справочника | Обязательное поле. | |
| 4 | massivechange | json | Массив в формате json с данными необходимыми для вставки | Массив должен состоять из ассоциативных массивов с данными для вставки записи в справочник. Такой массив должен содержать данные в формате КЛЮЧ=ЗНАЧЕНИЕ, где КЛЮЧ - это идентификатор требуемого поля | |
| 5 | dataFromBody | boolean | Брать данные не из аргументов, а из body | Не обязательное поле. | Если передан dataFromBody=1, то данные будут братся не из аргументов, а из тела запроса. В тело должен быть передан json, в котором ключами должны быть параметры, описанные выше. login и password пи этом должны посылатся как обычно |
Редактирование нескольких записей в справочнике, метод: /api/directory/change/?actiontype=update
Параметры
Пример:
http://myboxurl/api/directory/change/?login=XXXX&password=YYY&actiontype=update&directoryid=1&massivechange=[{"field1":"11","data":{"field1":"val1","field2":"val2"}},{"field1":"val1","data":{"field1":"val1","field2":"val2"}}]
| № | Поле | Тип | Описание | Обязательное или нет | Коментарий |
| 1 | login | string | Логин в системе BOX | Обязательное поле. | |
| 2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
| 3 | directoryid | integer | id справочника | Обязательное поле. | |
| 5 | data | array | поля справочника для обновления | Ассоциативный массив значений для редактрование справочника. Массив содержит значения в формате КЛЮЧ=ЗНАЧЕНИЕ, где КЛЮЧ - это идентификатор требуемого поля | |
| 6 | id или recordid | integer | id записи справочника | Не обязательное поле. | Если желаете изменить конкретную запись справочника |
| 7 | [KEY] | string | поля справочника | Для поиска необходимой записи на редактирование можно передавать значение в формате КЛЮЧ=ЗНАЧЕНИЕ, где КЛЮЧ - это идентификатор требуемого поля | |
| 4 | massivechange | json | Массив в формате json с данными необходимыми для редактирования | Массив должен состоять из ассоциативных массивов с данными для вставки записи в справочник. Каждый ассоциативный массив должен имметь такию структуру:
|
|
| 5 | dataFromBody | boolean | Брать данные не из аргументов, а из body | Не обязательное поле. | Если передан dataFromBody=1, то данные будут братся не из аргументов, а из тела запроса. В тело должен быть передан json, в котором ключами должны быть параметры, описанные выше. login и password пи этом должны посылатся как обычно |
Получение одной записи или всех записей справочника, метод: /api/directory/get/
Параметры
Пример:
http://myboxurl/api/directory/get/?login=XXXX&password=YYY&directoryid=1
| № | Поле | Тип | Описание | Обязательное или нет | Коментарий |
| 1 | login | string | Логин в системе BOX | Обязательное поле. | |
| 2 | password | string | Пароль в формате md5 | Обязательное поле. | Напишите в техподдержку и мы выдадим вам hash для API |
| 3 | directoryid | integer | id справочника | Обязательное поле. | |
| 4 | recordid | integer | id записи справочника | Не обязательное поле. | Если желаете получить конкретную запись справочника |
Copyright © OneBox 2024
