Как отправить запрос

Существует несколько доступных способов работы с API. Самые простые — через наш Swagger или в Postman. Именно они и будут описаны в статье.

Swagger

Вы можете изучить методы и даже попробовать их в нашей Swagger-документации. Чтобы перейти к ней, введите в браузере [название вашего рабочего пространства].bot.one/swagger

Например:

example.bot.one/swagger

Swagger-документация API доступна без регистрации. То есть, если у вас нет аккаунта в Bot.one, вы все равно можете ознакомиться с методами. Но для отправки запросов в сервис нужно авторизоваться (см. Авторизация).

Чтобы отправить запрос в Swagger:

1. Разверните запрос.
2. Нажмите кнопку Try it out.
3. Укажите необходимые параметры прямо в форме запроса. Обязательные запросы отмечены required.
4. Нажмите кнопку Execute.
5. Если до этого вы не авторизовались в системе, появится стандартное окно авторизации браузера. Введите логин и пароль.

Запрос будет отправлен к веб-сервису Bot.one. На странице в разделе Responses появится ответ сервера Server response. Ниже расположено описание других возможных ответов сервера.

В разделе Responses также появится блок Curl и Request URL. Вы можете использовать сформированные блоки для отправки запроса через CLI (командную строку) или адресную строку браузера. Вы также можете использовать их для создания workflow взаимодействия с внешними сервисами.

Postman

Вы можете использовать Postman для отправки запросов API. Для этого установите приложение Postman или зарегистрируйтесь в веб-версии. Подробно о том, как работать с Postman читайте в Postman Support Center.

Импорт коллекции методов

После авторизации импортируйте коллекцию методов нашего API:

1. Скачайте коллекции по ссылкам.
2. Откройте Postman. Выберите меню — File — Import.
3. Откроется окно Import. Нажмите кнопку Upload Files.
4. Выберите скаченные файлы с коллекциями API Bot.one и нажмите Открыть.
5. Выбранные файлы отобразятся в таблице. Нажмите Import.

В результате коллекция будет загружена в Postman, методы появятся на панели слева.

Отправка запроса

Теперь все доступные методы доступны у вас в Postman. Отправить запрос очень просто.

Для этого:

1. Выберите метод на боковой панели.
2. Справа появится запрос и его параметры.
3. В строке запроса на месте {{URL}} введите адрес вашего инстанса, например: manual.bot.one.
4. Запрос также может содержать другие параметры в заголовке, без которых он не будет отправлен. Такие параметры выделены цветом и фигурными скобками {{}}. Добавьте на место скобок нужные данные.
5. На вкладке Params перечислены все параметры, которые могут быть добавлены в query запроса. Эти параметры могут быть обязательными или необязательными. Вкладка может совсем не иметь параметров — значит, запрос их не требует. Для добавления параметра в запрос, установите флаг и введите значение в столбце VALUE. Если вы передумали указывать значение параметра, снимите флаг — иначе запрос не будет отправлен.
6. На вкладке Auth укажите параметры авторизации. Без них запрос не будет отправлен. В Type выберите Basic Auth и введите логин (email) и пароль вашего аккаунта Bot.one в полях Username и Password.
7. Некоторые методы предполагают отправку JSON в теле запроса. Для этого перейдите на вкладку Body, выберите в поле слева тип данных raw, а справа — JSON. Впишите json или измените данные в уже написанном.
8. Теперь запрос готов к отправке. Нажмите кнопку Send.

Запрос будет отправлен на сервер с теми параметрами, которые вы указали. В нашем API вы работаете с реальными данными, поэтому все изменения отобразятся на вашем инстансе: если запрос должен начать диалог, то при успешном запросе диалог будет начат и добавлен на сервер.

Полученный ответ появится в нижней части страницы. Вы увидите код ответа и его содержимое. При успешном запросе в ответе вернуться данные, при неуспешном — описание ошибки, которое поможет вам исправить запрос, чтобы отправить его заново.

Копирование и сохранение запроса

Чтобы сохранить запрос с теми параметрами, которые вы добавили, нажмите кнопку Save в верхней части страницы.

Чтобы скопировать код запрос и использовать его в CLI, строке браузера или в различных workflow:

1. Нажмите Code справа.
2. Откроется панель Code snippet. На панели написан запрос в cURL. Вы можете скопировать и использовать его, или изменить язык запроса на нужный вам.