Песочница (Sandbox) REST 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
Для REST API доступен параметр sandbox, который можно передать в любой из методов OneBox Rest Api.
Если передан этот параметр, метод не будет выполнять никаких запросов в базу данных, помимо проверки логина и пароля. В таком случае, будет проверяться лишь корректность данных (т.е. переданы ли все обязательные параметры). В случае правильно выполненого запроса вернется ответ:
Пример использования:
Если передан этот параметр, метод не будет выполнять никаких запросов в базу данных, помимо проверки логина и пароля. В таком случае, будет проверяться лишь корректность данных (т.е. переданы ли все обязательные параметры). В случае правильно выполненого запроса вернется ответ:
{"status":"ok"}
Если же были переданы не все обязательные поля, или переданы неправильные логин и\или пароль, вернется {"status":"error"} с текстом ошибки.
Пример использования:
http://myboxurl/api/brand/add/?login=LOGIN&password=PASSWORD&name=TestBrand&sandbox=1
Ответ:
{"status":"ok"}
В OneBox есть готовая страница, на которой можно потестировать REST API. Найти ее можно по ссылке /admin/shop/api/sandbox/
Copyright © OneBox 2024
