Главная / Платформа / API Документация

Разработчик

Расширяйте возможности СТРУКТУРЫ. RESTful API, SDK для популярных языков и мощная система вебхуков для интеграции с вашей экосистемой.

01 // AUTH

Аутентификация и безопасность

Доступ к API осуществляется через Bearer-токены в заголовке Authorization. Мы используем стандарт OAuth 2.0 с поддержкой PKCE для публичных клиентов.

Каждый токен привязан к конкретному Workspace ID и имеет ограниченный срок жизни (24 часа). Для долгосрочной интеграции предусмотрен механизм рефреш-токенов.

POST /v1/auth/token
{
  "client_id": "app_structura_prod",
  "client_secret": "sk_live_8f7d...",
  "grant_type": "client_credentials",
  "scope": "read:cashflow write:reports"
}
Схема API аутентификации
Схемы данных

Модели и объекты

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

MODEL // TRANSACTION

Транзакции

/v1/transactions

Базовый объект для всех движений средств. Содержит поля amount (integer), currency (ISO 4217), counterparty_id и category_uuid.

MODEL // FORECAST

Прогнозы

/v1/forecasts

Вероятностные данные о будущем состоянии кассы. Массив объектов с полями date, predicted_balance, confidence_interval_low и confidence_interval_high.

MODEL // ENTITY

Субъекты

/v1/entities

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

03 // EVENTS

Вебхуки и события

Подпишитесь на изменения в состоянии системы в реальном времени. СТРУКТУРА отправляет JSON-payload на ваш endpoint при наступлении ключевых событий.

Все события подписываются криптографически. Проверка подписи обязательна для защиты от CSRF-атак.

Список событий

  • cashflow.alert Обнаружен риск кассового разрыва
  • transaction.new Новая транзакция подтверждена
  • forecast.updated Модель пересчитала прогноз
{ } Event Payload
04 // SDK

Клиентские библиотеки

Ускорьте разработку с помощью официальных SDK. Полная типизация, автоматическая обработка пагинации и встроенная логирование.

Python

v3.2.0

pip install structura-py

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

Node.js

v2.1.4

npm i @structura/sdk

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

Go

v1.0.2

go get github.com/structura/go

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

cURL

Universal

Для быстрого тестирования и интеграции в CI/CD пайплайны без установки зависимостей.

Примеры