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
