API-референс

Developer Portal API

Полный справочник REST-эндпоинтов портала разработчика: база https://kazsmartchain.org/api/devportal

Все пути ниже указаны относительно базы https://kazsmartchain.org/api/devportal. Метка авторизации: public — без токена, Bearer (dev) — JWT разработчика, API key — заголовок x-api-key.

Аутентификация#

Вход в портал выполняется по ЭЦП через NCALayer — см. раздел Аутентификация. После входа портал выдаёт сессионный токен разработчика; защищённые эндпоинты вызываются с заголовком Authorization: Bearer <token>. Для машинного доступа к контрактам используйте API-ключи.

GET/auth/meBearer (dev)

Профиль текущего разработчика.

Кошелёк и faucet#

GET/wallets/:address/balancepublic

Баланс адреса. Query: network. Ответ: { address, network, wei, eth }.

POST/faucet/dripBearer (dev)

Начисление тестового газа. Тело: { network? }. Только testnet, лимит 5/сутки.

GET/developers/:id/wallet-historyBearer (dev)

История транзакций кошелька. Query: network. Ответ: массив WalletHistoryItem.

Контракты#

POST/contracts/compilepublic

Компиляция Solidity. Тело: { source, fileName? }.

POST/contracts/deployBearer (dev)

Компиляция и деплой. Тело: { source, contractName?, constructorArgs?, network?, projectId? }.

GET/contracts/:idpublic

Получить запись контракта.

GET/developers/:id/contractsBearer (dev)

Список контрактов разработчика.

POST/contracts/:id/register-fireflypublic

Регистрация контракта в FireFly.

GET/contracts/:id/openapi.jsonpublic

OpenAPI 3.0.3 спецификация gateway данного контракта.

GET/contracts/:id/swaggerpublic

FireFly-сгенерированный Swagger (после регистрации в FireFly).

API-ключи#

POST/developers/:id/api-keysBearer (dev)

Выпуск ключа. Тело: { name?, scopes?, contractId?, projectId? }. Ключ ksc_… возвращается один раз.

GET/developers/:id/api-keysBearer (dev)

Список ключей (без секрета).

DELETE/api-keys/:keyIdBearer (dev)

Отзыв ключа.

Аналитика#

GET/developers/:id/analyticsBearer (dev)

Агрегированные метрики использования. Query: days (1–90, по умолчанию 14).