Swagger

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

Например:

example.bot.one/swagger

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

Swagger API Bot.one
Figure 1. Swagger API Bot.one
Чтобы отправить запрос в Swagger:
  1. Разверните запрос.

  2. Нажмите кнопку Try it out.

  3. Укажите необходимые параметры прямо в форме запроса. Обязательные запросы отмечены required.

  4. Нажмите кнопку Execute.

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

Отправка запроса Swagger
Figure 2. Отправка запроса Swagger

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

Получение ответа Swagger
Figure 3. Получение ответа Swagger

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

Статья помогла вам?

На этой странице: