Appearance

API ​

Web3alert API 允许使用与 web UI 相同的实体：workspaces、projects、triggers、templates、subscriptions、resources、data sources 和 addresses。

Base URL:

text
https://web3alert.io

marketplace 和 builder 功能的主要 API 版本是 v2。部分 account/subscription/address book endpoints 目前仍保留在 v1。

Auth ​

用户请求使用 personal access token：

http
Authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN

Token 可以在 Account parameters 中获取。

Endpoint access 取决于：

  • account tier；
  • 用户在 workspace 中的角色；
  • project/data source/resource access level；
  • 实体状态。

External API requests 会按 tier 限制。详细数值见 Limits。

Response format ​

成功 response 会返回 endpoint JSON。

详细的 response body 结构见 Types。

错误返回格式：

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

超过 external API limit 时，会返回 429 和 headers：

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

Account ​

详情：Account API。

MethodEndpointPurpose
POST/api/v1/tokenauth flow 后创建或获取 API token。
GET/api/v1/me获取当前 account、identity、tier 和 memberships。
DELETE/api/v1/me删除当前 account。
PUT/api/v1/me/meta更新 account metadata。
POST/api/v1/me/avatar上传当前 account avatar。
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。

MethodEndpointPurpose
GET/api/v2/workspaces当前 account 的 workspaces 列表。
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 avatar。
GET/api/v2/workspaces/:workspace/acl获取 workspace members/ACL。
POST/api/v2/workspaces/:workspace/acl创建 invite 或 ACL entry。
PUT/api/v2/workspaces/:workspace/acl/:entryId修改 member role。
DELETE/api/v2/workspaces/:workspace/acl/:entryId删除 member/ACL entry。

Projects ​

详情：Projects API。

MethodEndpointPurpose
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通过 access link 打开 private project。
POST/api/v2/projects/:fullname/access-links为 project 创建 access link。
POST/api/v2/projects/:fullname/assets/images上传 project icon 或 cover。
DELETE/api/v2/projects/:fullname/images/:asset删除 uploaded project image。

Project Transfers ​

详情：Project Transfers API。

MethodEndpointPurpose
POST/api/v2/projects/:fullname/transfer/plan获取 project transfer plan。
POST/api/v2/projects/:fullname/transfer-requests创建 transfer request。
GET/api/v2/project-transfer-requestsincoming/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。

MethodEndpointPurpose
GET/api/v2/triggers带 filters 的 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/patchBulk patch triggers。
POST/api/v2/triggers/removeBulk remove triggers。
GET/api/v2/triggers/:fullname/draft获取 trigger draft view。
PUT/api/v2/triggers/:fullname/draft保存 trigger draft。
POST/api/v2/triggers/:fullname/draft/validate验证 trigger draft。
POST/api/v2/triggers/previewPreview trigger execution。
POST/api/v2/triggers/test在 sample source item 上 test trigger。
POST/api/v2/triggers/test-block在指定 block 上 test trigger。
POST/api/v2/triggers/providers/testTest 单个 provider。
GET/api/v2/triggers/runtime-sourcesruntime data sources 列表。
POST/api/v2/triggers/find-latest-block为 trigger 查找或准备 test input/block。

Trigger Import ​

详情：Trigger Import API。

MethodEndpointPurpose
POST/api/v2/triggers/import/evm加载 EVM ABI entries。
POST/api/v2/triggers/import/evm/abi按 contract address detect/load ABI。
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获取一个 Substrate pallet 的 metadata。

Templates ​

详情：Templates API。

MethodEndpointPurpose
GET/api/v2/projects/:fullname/templatesproject templates 列表。
GET/api/v2/projects/:fullname/template获取 project root template。
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。

MethodEndpointPurpose
GET/api/v1/subscriptions当前 workspace/account subscriptions 列表。
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/testTest subscription。
GET/api/v2/subscriptions/alerts/historyWorkspace subscription logs。
GET/api/v2/subscriptions/:id/alerts/history指定 subscription 的 logs。

Resources ​

详情：Resources API。

MethodEndpointPurpose
GET/api/v2/resourcesresources 列表。
GET/api/v2/resources/:fullname获取 resource。
PUT/api/v2/resources/:fullname创建或更新 resource。
DELETE/api/v2/resources/:fullname删除 resource。
GET/api/v2/resources/external/:token通过 token 打开 external resource setup。
POST/api/v2/resources/external/:token发送 external resource setup payload。

Data Sources ​

详情：Data Sources API。

MethodEndpointPurpose
GET/api/v2/custom-sourcescustom 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检查 custom source status。
POST/api/v2/custom-sources/:fullname/restart重启 custom source。
POST/api/v2/custom-sources/:fullname/reset-lagreset custom source lag。

Addresses ​

详情：Addresses API。

MethodEndpointPurpose
GET/api/v1/addressbookaddresses 列表。
POST/api/v1/addressbook创建 address。
POST/api/v1/addressbook/:id更新 address。
DELETE/api/v1/addressbook/:id删除 address。

Apps, Actions, Blueprints and Types ​

详情：Apps, Actions, Blueprints and Types API。

MethodEndpointPurpose
GET/api/v2/appsapps 列表。
GET/api/v2/apps/:fullname获取 app。
PUT/api/v2/apps/:fullname创建或更新 app。
DELETE/api/v2/apps/:fullname删除 app。
GET/api/v2/actionsactions 列表。
GET/api/v2/actions/:fullname获取 action。
PUT/api/v2/actions/:fullname创建或更新 action。
DELETE/api/v2/actions/:fullname删除 action。
GET/api/v2/blueprintsblueprints 列表。
GET/api/v2/blueprints/:fullname获取 blueprint。
PUT/api/v2/blueprints/:fullname创建或更新 blueprint。
DELETE/api/v2/blueprints/:fullname删除 blueprint。
GET/api/v2/typesshared types 列表。
GET/api/v2/types/:fullname获取 shared type。
PUT/api/v2/types/:fullname创建或更新 shared type。
DELETE/api/v2/types/:fullname删除 shared type。