Инфраструктурный API
Как устроена платформа ForestVPN — проекты, плоскости, аутентификация и руководства, которые проведут вас от нуля до продакшена.
Инфраструктурный API ForestVPN — это один HTTPS-API по адресу
https://api.fvpn.net, разделённый на плоскости по ролям: префикс URL
сообщает, от чьего имени действует вызов:
/platform/v1/*— поверхность проекта: всё, что вы делаете от имени проекта (управление проектом, выпуск API-ключей, чтение биллинга, просмотр вебхуков). Аутентификация через сессию консоли или API-ключ проекта./consumer/v1/*— поверхность конечного пользователя: всё, что делает конечный пользователь проекта (потребительский аккаунт и его устройства). Аутентификация по учётным данным потребителя/устройства, но никогда по ключам сотрудников.
Каждая операция обеих плоскостей описана в справочнике API, сгенерированном из тех же закоммиченных OpenAPI-документов, из которых собираются клиенты SDK — справочник и клиенты не могут расходиться.
Ментальная модель
- Проект — это ваш изолированный тенант:
участники, ключи, потребители, устройства и биллинг привязаны к нему.
Запросы несут UUID проекта в заголовке
X-Project-Id. - Потребители — это ваши конечные
пользователи: отдельная система идентификации (
/consumer/v1), полностью замкнутая внутри вашего проекта. - Устройства принадлежат потребителям и являются той единицей, которую VPN на самом деле подключает.
- Биллинговые вебхуки дают вам проверяемую запись о каждом биллинговом событии вендора, которое платформа обработала для вашего проекта.
API-ключи
Выпустите привязанный к проекту ключ fvpn_v1_ в консоли и сделайте первый аутентифицированный вызов.
Проекты
Граница тенанта — участники, роли, приглашения, передача и журнал аудита.
Потребители
Ваши конечные пользователи — аккаунты, аутентификация устройств, сессии и изоляция данных.
Устройства
Регистрация, авторизация, heartbeat-сигналы, ротация ключей и роли выходных узлов.
Биллинговые вебхуки
Наблюдайте, ищите и повторяйте биллинговые события вендора, записанные для вашего проекта.