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

Справка по API

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

Получить API Key Исходный код SDK
Схема архитектуры API JsonForge
01. Безопасность

Методы аутентификации

Все запросы к JsonForge API должны быть аутентифицированы. Мы используем стандартный механизм Bearer-токенов.

API Keys (REST)

Для доступа к методам REST API передавайте ваш секретный ключ в заголовке Authorization.

Authorization: Bearer jf_live_sk_882910x9210x921

OAuth 2.0 (Webhooks)

Для интеграции с внешними сервисами (Jira, Slack, GitHub) поддерживается авторизация через OAuth 2.0. Состояние сессии хранится 24 часа.

02. Ресурсы

Основные эндпоинты

API организован вокруг ресурсов: Схемы (Schemas), Трансформации (Transforms) и Проекты (Projects).

GET /v2/schemas

Возвращает список всех схем в текущем проекте. Поддерживает пагинацию через limit и offset.

Status: 200 OK
Response: JSON Array

POST /v2/transform

Выполняет трансформацию данных на лету. Принимает JSON-тело и ID правила трансформации.

Status: 201 Created
Content-Type: application/json

PUT /v2/schemas/:id

Обновляет существующую JSON схему. Заменит текущую версию и создаст новую ревизию в истории.

Status: 200 OK
Header: X-Revision-ID
120
Запросов / мин
50ms
Средний P99
JSON
Формат ответа
TLS 1.3
Шифрование

Словарь кодов ошибок

401 Unauthorized
Неверный или истекший API ключ. Проверьте, что вы используете live ключ для продакшена и test для песочницы.
422 Unprocessable Entity
Ошибка валидации входных данных. Тело ответа содержит массив errors с указанием путей к невалидным полям JSON.
429 Too Many Requests
Превышен лимит запросов (Rate Limit). Повторите запрос через время, указанное в заголовке Retry-After.
503 Service Unavailable
Временная недоступность сервиса. JsonForge находится на техобслуживании или发生过 перегрузка.
Инструменты

Официальные SDK

Не пишите HTTP-клиенты вручную. Используйте наши нативные библиотеки для быстрой интеграции.