OLESA
English
API и интеграции

Postman: коллекция запросов для скачивания

Скачать коллекцию

Скачать O·LESA API — Postman Collection v2.1 (.json)

В коллекции 20 запросов: каталог моделей, текстовый ответ и SSE, запуск и результаты агентов, расписания, собственные процессы, регистрация вебхуков и журнал доставок. Файл не содержит реальных ключей или пользовательских данных.

Импорт и настройка

  1. Скачайте JSON и импортируйте его через Import в Postman.
  2. В переменной base_url оставьте https://api.o-lesa.ru/v1 или укажите API-хост своего экземпляра. Для .com используйте https://api.o-lesa.com/v1. Завершающий слеш не нужен.
  3. Создайте ключ в Настройки → API с нужными правами. Задайте api_key локально в Postman, лучше в отдельном окружении как секрет. Не публикуйте и не синхронизируйте значение в общей коллекции.
  4. Отправьте Каталог моделей. Авторизация Bearer наследуется всеми запросами от коллекции.
  5. Скопируйте выбранный ID в model. Другие переменные: run_id, schedule_id, draft_id, webhook_id, webhook_url.

Для моделей нужно право models, для агентов и вебхуков — agents. Настройки одного окружения могут перекрывать одноимённые переменные коллекции; не создавайте лишних копий run_id и других автоматически сохраняемых ID.

Защита от случайного расхода

По умолчанию allow_writes=false: pre-request script пропускает POST/PATCH и другие изменяющие запросы. Для осознанного запуска установите allow_writes=true. Для DELETE дополнительно требуется allow_delete=true. Причина пропуска видна в Postman Console.

Используйте актуальный Postman с поддержкой pm.execution.skipRequest(). Не удаляйте защитный скрипт ради запуска коллекции целиком. После проверки верните разрешающие переменные в false.

Запросы с пометкой «платно» расходуют баланс. Повтор POST может создать ещё одну задачу или ответ: идемпотентность пока не поддерживается. Запускайте запросы по одному, не нажимайте Run для всей коллекции без проверки каждого действия.

Создание расписания включает его сразу. Пример одноразовый, но следующий запуск всё равно платный. После теста отключите расписание. Запуск собственного процесса может выполнять действия в ваших подключённых сервисах — предварительно проверьте граф.

ID и секрет вебхука

После успешного создания запуска, расписания или получателя коллекция сохраняет соответствующий ID в переменные. Для получения результата достаточно открыть следующий запрос с этим ID.

Секрет whsec_… из ответа регистрации вебхука не сохраняется скриптами. Сохраните его самостоятельно в защищённом окружении своего сервера. Проверка подписи и пример приёмника приведены в статье «Вебхуки: доставка и проверка подписи».

Коллекция только вызывает API O·LESA. Принимать исходящие вебхуки нужно на собственном публичном HTTPS-сервере. Запрос журнала доставок не заменяет приёмник.