Огляд API

Початок роботи

Огляд API

BroSettlement Integration API надає доступ у межах організації до активів, рахунків операційного журналу, гаманців, балансів, транзакцій, MPC, транспорту Co-Signer та журналу аудиту.

Base URL і версія

Усі описані REST endpoints використовують префікс /api/v1:

text
https://brosettlement-staging-api.brolabel.io/api/v1

WebSocket-події доступні за адресою:

text
wss://brosettlement-staging-api.brolabel.io/v1/ws

Поверхня API

НапрямОпераційПризначення
Assets1Пошук підтримуваних мереж, активів, token standards і доступності
Ledger accounts6Створення рахунків і читання їхніх гаманців, балансів та транзакцій
Wallets and balances5Створення або перегляд гаманців, проєкцій балансу та записів журналу
Transactions3Створення виведень і читання стану транзакцій
MPC2Ініціалізація ключа організації та перевірка готовності
MPC Co-Signer5Отримання intents, обмін protocol messages і передавання результатів
Audit Logs1Пошук у журналі аудиту організації

Поточний Swagger містить 19 paths і 23 REST operations.

Автентифікація

REST-запити використовують Ed25519 API key. Для кожної операції потрібні:

  • X-Api-Key-Id
  • X-Api-Timestamp
  • X-Api-Nonce
  • X-Api-Signature

Для mutating operations із body також потрібен X-Api-Body-Hash. Частина операцій вимагає X-Idempotency-Key. Докладніше: Автентифікація API та Правила API.

Необхідні scopes

ScopeДля чого використовується
wallets:readАктиви, гаманці, баланси рахунків/гаманців і записи журналу
wallets:createСтворення гаманців і рахунків
accounts:readСписок і деталі рахунків
transactions:readСписок і деталі транзакцій
withdrawals:createСтворення вихідних транзакцій
mpc:initializeІніціалізація MPC
mpc:readСтатус MPC
mpc:rawОперації протоколу Co-Signer
audit-logs:readЖурнал аудиту організації
websockets:readWebSocket-події

Створюйте окремі API keys для незалежних сервісів і надавайте лише необхідні scopes.

Індекс endpoints

MethodPathScope
GET/api/v1/assetswallets:read
GET, POST/api/v1/ledger/accountsaccounts:read або wallets:create
GET/api/v1/ledger/accounts/{accountId}accounts:read
GET/api/v1/ledger/accounts/{accountId}/walletswallets:read
GET/api/v1/ledger/accounts/{accountId}/balanceswallets:read
GET/api/v1/ledger/accounts/{accountId}/transactionstransactions:read
GET, POST/api/v1/walletswallets:read або wallets:create
GET/api/v1/wallets/{walletId}wallets:read
GET/api/v1/wallets/{walletId}/balanceswallets:read
GET/api/v1/wallets/{walletId}/ledger-entrieswallets:read
GET, POST/api/v1/transactionstransactions:read або withdrawals:create
GET/api/v1/transactions/{id}transactions:read
POST/api/v1/mpc/initializempc:initialize
GET/api/v1/mpc/statusmpc:read
GET, POST/api/v1/co-signer/...mpc:raw
GET/api/v1/orgs/{orgId}/audit-logsaudit-logs:read