Фуражир / backend и интеграции

API — часть продукта.
Не побочный эффект интерфейса.

Фуражир даёт стабильный публичный API v1 для внешних сервисов и отдельные методы для панели управления. Документированы 7 публичных операций, 54 серверных маршрутов и 39 правил изменения данных — с OpenAPI и TypeScript SDK для интеграций.

01публичных операций v1
7
02серверных маршрутов
54
03правил изменения данных
39
04машиночитаемая схема
OpenAPI 3.1
01 / ПУБЛИЧНЫЙ API V1

Стабильные методы для внешних интеграций

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

01правила чтения

Каталог, контент и поиск

Операции чтения имеют явные права доступа, постраничную выдачу, фильтры и ограничения. Формат ответа не зависит от устройства интерфейса.

02orders:write

Создание заказа

Команда создания требует Idempotency-Key длиной 32–128 символов, поэтому безопасный повтор не создаёт дубликат при сетевом сбое.

03понятная диагностика

Единый формат ошибок

Ошибки, идентификатор запроса и заголовки ограничений дают интегратору предсказуемую диагностику без разбора HTML или случайных сообщений.

02 / ИНСТРУМЕНТЫ РАЗРАБОТЧИКА

Контракт можно прочитать, запустить и проверить

Документация не ограничивается списком адресов. Схема, SDK и безопасная песочница показывают единую модель запросов.

01спецификация

OpenAPI 3.1

Машиночитаемая схема описывает методы и данные публичного API; её можно использовать для проверки и генерации вспомогательных инструментов.

02готовый клиент

TypeScript SDK

Клиент без внешних зависимостей поддерживает тайм‑аут, отмену, типизированные ошибки и запрещает перенаправление запросов с ключами доступа.

03безопасная проверка

Проверка API в демо

Раздел разработчика позволяет выполнять запросы к демо‑API на учебных данных без обращения к реальным внешним сервисам.

03 / ФОНОВЫЕ ПРОЦЕССЫ

Успешный ответ — ещё не конец операции

Ответ HTTP 200 сам по себе не гарантирует доставку письма, уведомления или платёжной операции. Внешние действия требуют контролируемой фоновой очереди.

01надёжная постановка

Очередь фоновых задач

Изменение данных и запись о будущем действии фиксируются вместе, затем отдельный процесс выполняет доставку и управляет повторами.

02проверить источник

Уведомления и повторная сверка

Подпись и origin — только первый шаг. После уведомления провайдерский объект повторно читается по API перед изменением критичного состояния.

03наблюдение

Состояние и диагностика

Доступность зависимостей проверяется отдельно от работы процесса, фоновые задачи подают контрольный сигнал, а журнал связывает действие с результатом без записи секретов.

04 / ПОВЕРХНОСТИ API

Разные потребители — разные границы

Не все внутренние маршруты должны становиться публичными. Стабильность и безопасность проще поддерживать, когда у каждого вида доступа есть понятная граница.

ПоверхностьДля когоГраница
Публичный /api/v1Внешние интеграцииВерсия, ключ API, права, ограничения
Демо /api/demo/v1Проверка перед покупкойУчебные данные, без реальных внешних действий
Методы панелиПанель управленияСерверная сессия, проверка источника
Уведомления поставщиковПлатежи и интеграцииПроверка, защита от дублей, сверка через API
Фоновые задачиВнешние действияОчередь, повторы, контрольный сигнал

СЕКРЕТЫ И БРАУЗЕР

Привилегированный ключ API не хранится в браузере

Ключ для обмена между серверами хранится в защищённой конфигурации backend или интеграционной платформы. Для прямого доступа из браузера нужна отдельная пользовательская авторизация.

  • 01

    Authorization: Bearer и X-API-Key поддерживаются серверной интеграцией.

  • 02

    Права ограничивают назначение ключа, но не заменяют его смену и отзыв.

  • 03

    Перенаправление запросов с ключами запрещено, чтобы ключ не ушёл на другой адрес.

05 / ОТВЕТЫ

Вопросы по теме

01Можно ли использовать API без административного интерфейса?

Да. Публичный API v1 предназначен для обмена между серверами. Панель управления использует отдельные внутренние методы под защищённой серверной сессией.

02Можно ли положить ключ API в браузерное приложение?

Привилегированный ключ — нет. Его нужно держать на сервере. Для прямого клиентского доступа проектируется отдельная пользовательская авторизация с минимальными правами.

03Можно ли подключить существующий backend?

Да. Существующие сервисы можно сохранить источниками данных и связать с Фуражиром через публичный API или проектные адаптеры.

ПРОВЕРИТЬ КОНТРАКТ

От операции в таблице — к живому запросу

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