Econoverse APIполная документация · v1

Публичный API v1

Через API доступно всё, что умеет бот: профиль, переводы, компании, налоги, приложения и полный набор админ-действий.

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

1. Приложение (api_key)

Создайте приложение командой /newapp Название в боте. Ключ передаётся заголовком X-Api-Key: <api_key> или Authorization: ApiKey <api_key>.

2. Пользователь (Bearer access_token)

Пользователь получает код привязки командой /mycode (или в Mini App). Приложение обменивает код на токен через POST /api/v1/oauth/exchange и передаёт его в каждом запросе: Authorization: Bearer <access_token> (вместе с X-Api-Key). Код действует 10 минут и одноразовый.

3. Админ-действия (api_secret)

Доступны только приложениям, созданным администратором. Дополнительно к X-Api-Key передайте X-Api-Secret: <api_secret> (или поле api_secret в JSON-теле для POST).

  

Формат ответов и ошибки

Все ответы — JSON с полем ok. При ошибке: {"ok": false, "error": "текст", "code": "error_code"} и соответствующий HTTP-статус.
HTTPcodeЗначение
401invalid_api_key / invalid_api_secret / missing_token / invalid_tokenПроблема с аутентификацией
402insufficient_fundsНедостаточно средств
403user_banned / not_owner / forbidden_not_admin_appДействие запрещено
404user_not_found / company_not_found / code_not_found / app_not_foundОбъект не найден
409code_used / name_taken / already_in_company / already_registeredКонфликт состояния
410code_expiredСрок действия кода истёк
400invalid_amount / missing_param / ...Некорректные параметры

Команды бота для разработчиков

КомандаОписание
/newapp НазваниеСоздать приложение — выдаёт api_key и api_secret
/myappsСписок ваших приложений
/revokeapp idОтозвать приложение и все его токены
/mycodeОдноразовый код привязки аккаунта (10 минут)
/apihelpКраткая справка по API

Справочник эндпоинтов

Нажмите на эндпоинт, чтобы раскрыть параметры и пример ответа.