Appearance

API ​

Web3alert API позволяет работать с теми же сущностями, что и web UI: workspaces, projects, triggers, templates, subscriptions, resources, data sources и addresses.

Базовый URL:

text
https://web3alert.io

Основная версия API для marketplace и builder-функционала - v2. Часть account/subscription/address book endpoints пока остается в v1.

Auth ​

Для пользовательских запросов используется personal access token:

http
Authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN

Токен можно получить в Account parameters.

Доступ к endpoint зависит от:

  • account tier;
  • роли пользователя в workspace;
  • access level project/data source/resource;
  • состояния сущности.

Внешние API-запросы лимитируются по tier. Подробные значения описаны в Limits.

Формат ответа ​

Успешный response возвращает JSON endpoint-а.

Подробные структуры response body описаны в Types.

Ошибка возвращается в формате:

json
{
  "error": {
    "message": "error message",
    "details": {}
  }
}

При превышении external API лимита возвращается 429 и headers:

http
Retry-After: 10
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 0
X-RateLimit-Window: 60000

Account ​

Подробно: Account API.

МетодEndpointНазначение
POST/api/v1/tokenСоздать или получить API-токен после процесса авторизации.
GET/api/v1/meПолучить текущий account, identity, tier и memberships.
DELETE/api/v1/meУдалить текущий account.
PUT/api/v1/me/metaОбновить метаданные account.
POST/api/v1/me/avatarЗагрузить аватар текущего account.
GET/api/v1/me/workspaceПолучить текущий workspace account.
POST/api/v1/me/workspaceСменить текущий workspace account.
GET/api/v1/account/settingsПолучить account settings.
POST/api/v1/account/settingsСохранить account settings.

Workspaces ​

Подробно: Workspaces API.

МетодEndpointНазначение
GET/api/v2/workspacesСписок workspaces текущего account.
GET/api/v2/workspaces/:fullnameПолучить workspace.
PUT/api/v2/workspaces/:fullnameСоздать или обновить workspace.
DELETE/api/v2/workspaces/:fullnameУдалить workspace.
POST/api/v2/workspaces/:fullname/avatarЗагрузить аватар workspace.
GET/api/v2/workspaces/:workspace/aclПолучить members/ACL workspace.
POST/api/v2/workspaces/:workspace/aclСоздать invite или ACL entry.
PUT/api/v2/workspaces/:workspace/acl/:entryIdИзменить роль member.
DELETE/api/v2/workspaces/:workspace/acl/:entryIdУдалить member/ACL entry.

Projects ​

Подробно: Projects API.

МетодEndpointНазначение
GET/api/v2/projectsСписок доступных projects.
GET/api/v2/projects/create-capabilityПроверить возможность создания project.
GET/api/v2/projects/:fullnameПолучить project.
PUT/api/v2/projects/:fullnameСоздать или обновить project.
DELETE/api/v2/projects/:fullnameУдалить project.
GET/api/v2/projects/by-link/:tokenОткрыть private project по access link.
POST/api/v2/projects/:fullname/access-linksСоздать access link для project.
POST/api/v2/projects/:fullname/assets/imagesЗагрузить project icon или cover.
DELETE/api/v2/projects/:fullname/images/:assetУдалить загруженное изображение project.

Project Transfers ​

Подробно: Project Transfers API.

МетодEndpointНазначение
POST/api/v2/projects/:fullname/transfer/planПолучить план переноса project.
POST/api/v2/projects/:fullname/transfer-requestsСоздать transfer request.
GET/api/v2/project-transfer-requestsСписок incoming/outgoing transfer requests.
POST/api/v2/project-transfer-requests/:id/acceptПринять transfer request.
POST/api/v2/project-transfer-requests/:id/rejectОтклонить transfer request.
POST/api/v2/project-transfer-requests/:id/cancelОтменить outgoing transfer request.

Triggers ​

Подробно: Triggers API.

МетодEndpointНазначение
GET/api/v2/triggersСписок triggers с фильтрами.
GET/api/v2/triggers/:fullnameПолучить trigger.
PUT/api/v2/triggers/:fullnameСоздать или полностью сохранить trigger.
PATCH/api/v2/triggers/:fullnameЧастично изменить trigger.
DELETE/api/v2/triggers/:fullnameУдалить trigger.
POST/api/v2/triggers/patchМассово изменить triggers.
POST/api/v2/triggers/removeМассово удалить triggers.
GET/api/v2/triggers/:fullname/draftПолучить draft view trigger.
PUT/api/v2/triggers/:fullname/draftСохранить draft trigger.
POST/api/v2/triggers/:fullname/draft/validateПроверить draft trigger.
POST/api/v2/triggers/previewПредпросмотр выполнения trigger.
POST/api/v2/triggers/testТест trigger на sample source item.
POST/api/v2/triggers/test-blockТест trigger на конкретном block.
POST/api/v2/triggers/providers/testТест одного provider.
GET/api/v2/triggers/runtime-sourcesСписок runtime data sources.
POST/api/v2/triggers/find-latest-blockНайти или подготовить test input/block для trigger.

Trigger Import ​

Подробно: Trigger Import API.

МетодEndpointНазначение
POST/api/v2/triggers/import/evmЗагрузить EVM ABI entries.
POST/api/v2/triggers/import/evm/abiНайти или загрузить ABI по адресу contract.
POST/api/v2/triggers/import/evm/draftsСгенерировать EVM trigger drafts.
POST/api/v2/triggers/import/substrate/draftsСгенерировать Substrate trigger drafts.
GET/api/v2/triggers/substrate/sourceПолучить Substrate source info.
GET/api/v2/triggers/substrate/palletsПолучить список Substrate pallets.
GET/api/v2/triggers/substrate/palletПолучить metadata одного Substrate pallet.

Templates ​

Подробно: Templates API.

МетодEndpointНазначение
GET/api/v2/projects/:fullname/templatesСписок templates project.
GET/api/v2/projects/:fullname/templateПолучить root template project.
POST/api/v2/projects/:fullname/templatesСоздать template/group.
GET/api/v2/projects/:fullname/templates/:idПолучить template.
PUT/api/v2/projects/:fullname/templates/:idОбновить template.
DELETE/api/v2/projects/:fullname/templates/:idУдалить template.

Subscriptions ​

Подробно: Subscriptions API.

МетодEndpointНазначение
GET/api/v1/subscriptionsСписок subscriptions текущего workspace/account.
POST/api/v1/subscriptionsСоздать subscription.
GET/api/v1/subscriptions/:idПолучить subscription.
POST/api/v1/subscriptions/:idОбновить subscription.
DELETE/api/v1/subscriptions/:idУдалить subscription.
POST/api/v1/subscriptions/:id/stateВключить или выключить subscription.
POST/api/v2/subscriptions/testТест subscription.
GET/api/v2/subscriptions/alerts/historySubscriptions logs workspace.
GET/api/v2/subscriptions/:id/alerts/historyLogs конкретной subscription.

Resources ​

Подробно: Resources API.

МетодEndpointНазначение
GET/api/v2/resourcesСписок resources.
GET/api/v2/resources/:fullnameПолучить resource.
PUT/api/v2/resources/:fullnameСоздать или обновить resource.
DELETE/api/v2/resources/:fullnameУдалить resource.
GET/api/v2/resources/external/:tokenОткрыть external resource setup по токену.
POST/api/v2/resources/external/:tokenОтправить payload external resource setup.

Data Sources ​

Подробно: Data Sources API.

МетодEndpointНазначение
GET/api/v2/custom-sourcesСписок custom data sources.
GET/api/v2/custom-sources/create-capabilityПроверить возможность создания custom source.
POST/api/v2/custom-sources/verifyПроверить custom source config.
GET/api/v2/custom-sources/:fullnameПолучить custom source.
PUT/api/v2/custom-sources/:fullnameСоздать или обновить custom source.
DELETE/api/v2/custom-sources/:fullnameУдалить custom source.
GET/api/v2/custom-sources/:fullname/logsПолучить custom source logs.
POST/api/v2/custom-sources/:fullname/test-statusПроверить status custom source.
POST/api/v2/custom-sources/:fullname/restartПерезапустить custom source.
POST/api/v2/custom-sources/:fullname/reset-lagСбросить lag custom source.

Addresses ​

Подробно: Addresses API.

МетодEndpointНазначение
GET/api/v1/addressbookСписок addresses.
POST/api/v1/addressbookСоздать address.
POST/api/v1/addressbook/:idОбновить address.
DELETE/api/v1/addressbook/:idУдалить address.

Apps, Actions, Blueprints и Types ​

Подробно: Apps, Actions, Blueprints и Types API.

МетодEndpointНазначение
GET/api/v2/appsСписок apps.
GET/api/v2/apps/:fullnameПолучить app.
PUT/api/v2/apps/:fullnameСоздать или обновить app.
DELETE/api/v2/apps/:fullnameУдалить app.
GET/api/v2/actionsСписок actions.
GET/api/v2/actions/:fullnameПолучить action.
PUT/api/v2/actions/:fullnameСоздать или обновить action.
DELETE/api/v2/actions/:fullnameУдалить action.
GET/api/v2/blueprintsСписок blueprints.
GET/api/v2/blueprints/:fullnameПолучить blueprint.
PUT/api/v2/blueprints/:fullnameСоздать или обновить blueprint.
DELETE/api/v2/blueprints/:fullnameУдалить blueprint.
GET/api/v2/typesСписок shared types.
GET/api/v2/types/:fullnameПолучить shared type.
PUT/api/v2/types/:fullnameСоздать или обновить shared type.
DELETE/api/v2/types/:fullnameУдалить shared type.