Документация

Демо-копии боевых API Bitrix24, Ozon Seller и Wildberries — как поднять стенд, как обращаться к мокам, как принимать события и как управлять всем этим программно.

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

APIStend отвечает на запросы так же, как отвечают боевые API Bitrix24, Ozon Seller и Wildberries: те же схемы ответов, те же коды ошибок, те же события. Вы подменяете базовый адрес — путь, HTTP-метод, заголовок авторизации и разбор ответа остаются прежними.

Эта страница — карта разделов. Если стенда ещё нет, начните с быстрого старта: он доводит от пустой машины до первого ответа мока.

Разделы

Начало

Что такое APIStendчто делает стенд, чем он не является и как устроен внутри Быстрый стартподнять стенд, получить ключ, увидеть первый ответ Основные понятияаккаунт, песочница, ключи, сценарии, сброс Совместимость и ограничениягде мок совпадает с боем, а где заведомо нет

Мок-API

Адресацияпрефиксы сервисов и единый префикс, чем они отличаются Авторизацияключ там же, где его ждёт боевой сервис Управление ответомсценарии ошибок и задержка вместо ожидания случая Заголовки ответаоткуда взято тело ответа и насколько готов мок метода Лимитыэмуляция ограничения частоты по профилю каждого сервиса Bitrix24что покрыто, откуда снята спецификация, чем мок отличается от портала Ozon Seller APIпокрытие, происхождение спецификации и отличия от боевого API Wildberriesпокрытие, происхождение спецификации и отличия от боевого API Apify APIпокрытие, лимиты по классам путей, акторы со схемами входа и выхода MCP-серверымок mcp.apify.com и собственный сервер APIStend для ИИ-агентов

События

Вебхукидоставка событий и различия профилей сервисов Доставка на localhostкак события приходят на машину без публичного адреса CLI apistendустановка, вход, приём и отправка событий из терминала Серии событийнагрузочная проверка обработчика Журнал доставоксостояния доставки и повтор неудачных

Bitrix24

Локальные приложениястенд в роли портала: OAuth, BX24.js, фрейм приложения Карточка приложенияполя, права, обработчик, установка и удаление Цикл OAuthauthorize, обмен кода, обновление по refresh_token Отладка приложенияжурнал моста и разбор типичных ошибок

Кабинет

Свои мокиэндпоинты, которых нет ни у одного из сервисов Импорт OpenAPIчто импорт читает, что игнорирует и как разрешает конфликты Консоль запросовзапрос к моку прямо из кабинета Журнал запросовфильтры, выгрузка и срок хранения Уведомления и сводкаиз чего считаются цифры на «Обзоре»

API управления

Обзор и аутентификациясерверный ключ, cookie-сессия и что API умеет Области доступаполный список scopes и правила их выдачи Соглашенияпостраничность, конверт ошибки, коды ответов, лимиты OpenAPI и клиентыгде спецификация и как сгенерировать по ней клиент Рецептыокружение под CI, ключ подрядчику, выгрузка журнала Аккаунт и сессиипрофиль, смена пароля, активные входы, удаление аккаунта Песочницысоздание, настройки поведения, сброс данных, удаление Ключивыпуск, ротация, отзыв и области доступа Вебхуки и доставкиподписки, тестовая отправка, журнал доставок, повторы Сценарии и сериизаготовки событий и нагрузочные серии Свои мокисобственные ответы, импорт OpenAPI, предпросмотр шаблона Логи и сводкажурнал запросов, выгрузка, статистика, уведомления Каталогсервисы, методы и события справочником Приложения Bitrix24карточки локальных приложений Туннельсостояние агента и очередь локальных доставок

Установка

Запуск одной командойчто поднимает docker compose и где остаются данные Разработка без контейнеровзапуск из исходников и структура монорепозитория Переменные окруженияполный список настроек и последствия неверных значений Развёртывание на своём сервереобраз, прокси, TLS, миграции, резервные копии Обновление и откатпорядок релиза и что делать после неудачного Диагностикачто показывает /health и куда смотреть при симптомах

Как читать эту документацию

Числа каталога живут в базе

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

Разделы «Мок-API» и «События» описывают то, с чем работает ваш код: адреса, заголовки, коды ответов и формат событий. «Кабинет» и «API управления» — два способа настроить одно и то же: первый через интерфейс, второй программно, теми же операциями. «Установка» нужна тем, кто поднимает стенд у себя, а не пользуется общим.

Полный список разделов всегда открыт слева, поиск — по ⌘K или Ctrl+K.

Дальше читайте

Быстрый стартот нуля до первого ответа мока Что такое APIStendобщая картина и границы применимости