跳到主要内容
版本：开发版本 🚧

应用接口

上传应用​

上传应用，仅支持 iOS, Android 和 macOS 类型。

POST /api/apps/upload

参数​

信息

需要用户认证

名称类型是否必须描述
fileFiletrue应用本地路径的内容
channel_keyStringfalse应用具体渠道的 Key，没有传此参数会字段创建对于的应用、类型和渠道
nameStringfalse应用名称，为空时取 App 的信息
release_typeStringfalse应用类型，比如 debug, beta, adhoc, release, enterprise 等
sourceStringfalse上传渠道名称，默认是 api
changelogStringfalse变更日志，接受纯文本或 JSON 格式化的数据
branchStringfalse上传应用时的git branch名称
git_commitStringfalse上传应用时的 git commit hash
ci_urlStringfalseCI 项目构建地址
custom_fieldsStringfalse这是一个用 JSON 字符串定义的自定义字段，
可配置名称，值以及 fontawesome 图标用于在页面详情展示

字段 changelog 可接受纯文本和 JSON 格式：

纯文本:

message 1\nmessage 2

JSON:

[
  {
    "message": "message 1",
    "author": "admin",
    "email": "admin@zealot.com",
    "date": "2021-11-11 11:11:11"
  },
  {
    "message": "message 1",
    "author": "developer",
    "email": "developer@zealot.com",
    "date": "2021-11-11 11:11:11"
  }
]

对于 custom_fields 的用法，它是一个使用 JSON 格式的以键值对为单位的数组，比如需要自定义国家 country=China 并配置图标为 fontawesome 的 flag

curl -X POST \
  'https://YOUR_ZEALOT_URL/api/apps/upload' \
   --form 'token="token"' \
   --form 'channel_key="channel_key"' \
+  --form 'custom_fields="[{"name":"country","value":"China","icon":"fas fa-flag"}]"' \
   --form 'file=@/path/to/your/app'

返回样例​

{
  "id": 50,
  "version": 7,
  "app_name": "Test Android",
  "bundle_id": "com.test.app",
  "release_version": "1.0",
  "build_version": "1",
  "source": "SOURCE",
  "branch": "master",
  "git_commit": "e9de48513dbb6abfbxxxxxxxxxxxxxxxxxxxxxxxx",
  "ci_url": "",
  "size": 1565486,
  "icon_url": "/uploads/apps/a1/r1/icons/app_icon.png",
  "release_url": "https://YOUR_ZEALOT_URL/channels/1XmpC/releases/1",
  "install_url": "https://YOUR_ZEALOT_URL/download/releases/1",
  "qrcode_url": "https://YOUR_ZEALOT_URL/channels/1XmpC/releases/1/qrcode?size=thumb",
  "changelog": [
    {
      "message": "Changelog message 1"
    },
    {
      "message": "Changelog message 2"
    }
  ],
  "text_changelog": "- Changelog message 1\n- Changelog message 2",
  "custom_fields": [],
  "created_at": "2021-09-01T11:43:33.977+08:00",
  "app": {
    "id": 1,
    "name": "App name"
  },
  "scheme": {
    "id": 8,
    "name": "Test"
  },
  "channel": {
    "slug": "1XmpC",
    "name": "Android",
    "device_type": "android",
    "bundle_id": "*",
    "git_url": null,
    "has_password": false
  }
}

应用列表​

获取创建的应用列表，支持分页

GET /api/apps

参数​

名称类型是否必须描述
pageIntegerfalse页数
per_pageIntegerfalse每页返回最大数目

返回样例​

[
  {
    "id": 1,
    "name": "Zealot",
    "schemes": [
      {
        "id": 1,
        "name": "测试版",
        "channels": [
          {
            "slug": "X1IXN",
            "name": "Android",
            "device_type": "android",
            "bundle_id": "*",
            "git_url": null,
            "has_password": false
          },
          {
            "slug": "O1qHk",
            "name": "iOS",
            "device_type": "ios",
            "bundle_id": "*",
            "git_url": null,
            "has_password": false
          }
        ]
      },
      {
        "id": 2,
        "name": "内测版",
        "channels": [
          {
            "slug": "l19Tl",
            "name": "Android",
            "device_type": "android",
            "bundle_id": "*",
            "git_url": null,
            "has_password": false
          },
          {
            "slug": "8selv",
            "name": "iOS",
            "device_type": "ios",
            "bundle_id": "*",
            "git_url": null,
            "has_password": false
          }
        ]
      }
    ]
  }
]

应用详情​

查看应用的明细：应用类型、渠道等信息

GET /api/apps/:id

参数​

名称类型是否必须描述
idIntegertrue应用 ID

返回样例​

{
  "id": 1,
  "name": "Zealot",
  "schemes": [
    {
      "id": 5,
      "name": "测试版",
      "channels": [
          {
            "slug": "X1IXN",
            "name": "Android",
            "device_type": "android",
            "bundle_id": "*",
            "git_url": null,
            "has_password": false
          },
          {
            "slug": "O1qHk",
            "name": "iOS",
            "device_type": "ios",
            "bundle_id": "*",
            "git_url": null,
            "has_password": false
          }
      ]
    }
  ]
}

应用版本列表​

获取应用已上传的版本列表，按照上传时间倒序排列

GET /api/apps/versions

参数​

名称类型是否必须描述
channel_keyStringtrue应用具体渠道的 Key
pageIntegerfalse页数
per_pageIntegerfalse每页返回最大数目

返回样例​

{
  "app_name": "Zealot iOS 测试版",
  "bundle_id": "*",
  "git_url": null,
  "app": {
    "id": 3,
    "name": "Zealot"
  },
  "scheme": {
    "id": 5,
    "name": "测试版"
  },
  "releases": [
    {
      "version": 2,
      "app_name": "Zealot iOS 测试版",
      "bundle_id": "im.ews.zealot",
      "release_version": "1.0.0",
      "build_version": "10292024",
      "source": "Web",
      "branch": "",
      "git_commit": "",
      "ci_url": "",
      "size": 79712596,
      "icon_url": "https://tryzealot.ews.im/uploads/apps/a3/r21/icons/8ab13dc08321f9f3412a9fa98689d9c3.png",
      "install_url": "itms-services://?action=download-manifest&url=https://tryzealot.ews.im/api/apps/O1qHk/1/install",
      "changelog": [],
      "created_at": "2019-12-25T14:26:06.608+08:00"
    },
    {
      "version": 1,
      "app_name": "Zealot iOS 测试版",
      "bundle_id": "im.ews.zealot",
      "release_version": "1.0.0",
      "build_version": "10291524",
      "source": "Web",
      "branch": "",
      "git_commit": "",
      "ci_url": "",
      "size": 79712596,
      "icon_url": "https://tryzealot.ews.im/uploads/apps/a3/r21/icons/8ab13dc08321f9f3412a9fa98689d9c3.png",
      "install_url": "itms-services://?action=download-manifest&url=https://tryzealot.ews.im/api/apps/O1qHk/1/install",
      "changelog": [],
      "created_at": "2019-12-25T14:26:06.608+08:00"
    },
  ]
}

应用最新版本​

获取指定应用的最新版本信息

GET /api/apps/latest

参数​

名称类型是否必须描述
channel_keyStringtrue应用具体渠道的 Key
release_versionStringtrue应用的发布版本
build_versionStringtrue应用的构建版本

返回样例​

{
  "app_name": "Zealot iOS 测试版",
  "bundle_id": "*",
  "git_url": null,
  "app": {
    "id": 3,
    "name": "Zealot"
  },
  "scheme": {
    "id": 5,
    "name": "测试版"
  },
  "releases": {
    "version": 1,
    "app_name": "Zealot iOS 测试版",
    "bundle_id": "im.ews.zealot",
    "release_version": "1.0.0",
    "build_version": "10291524",
    "source": "Web",
    "branch": "",
    "git_commit": "",
    "ci_url": "",
    "size": 79712596,
    "icon_url": "https://tryzealot.ews.im/uploads/apps/a3/r21/icons/8ab13dc08321f9f3412a9fa98689d9c3.png",
    "install_url": "itms-services://?action=download-manifest&url=https://tryzealot.ews.im/api/apps/O1qHk/1/install",
    "changelog": [],
    "created_at": "2019-12-25T14:26:06.608+08:00"
  }
}

检查当前版本是否存在​

使用 bundle_id、release_version、build_verion 或 bundle_id、git_commit 组合检查当前版本是否存在

GET /api/apps/version_exist

参数​

名称类型是否必须描述
channel_keyStringtrue应用具体渠道的 Key
bundle_idStringtrue应用的包名，iOS 取 bundle_id，Android 取 package_name
release_versionStringfalse应用的发布版本
build_versionStringfalse应用的构建版本
git_commitStringfalse上传应用时的 git commit hash

返回样例​

  • 版本存在返回 200 状态码并返回版本的信息
  • 版本不存在返回 404 状态码和错误信息

版本存在的返回信息

{
  "version": 1,
  "app_name": "好好住 iOS 测试版",
  "bundle_id": "com.haohaozhu.hhz",
  "release_version": "4.1.1",
  "build_version": "10291524",
  "source": "Web",
  "branch": "",
  "git_commit": "",
  "ci_url": "",
  "size": 79712596,
  "icon_url": "https://tryzealot.ews.im/uploads/apps/a3/r21/icons/8ab13dc08321f9f3412a9fa98689d9c3.png",
  "install_url": "itms-services://?action=download-manifest&url=https://tryzealot.ews.im/api/apps/O1qHk/1/install",
  "changelog": [],
  "created_at": "2019-12-25T14:26:06.608+08:00"
}

版本不存在的返回信息：

{
  "error": "应用版本不存在"
}

创建应用​

使用传递的参数创建应用

POST /api/apps

参数​

信息

需要用户认证

名称类型是否必须描述
nameStringtrueThe name of App

返回样例​

  • 请求参数无效返回 422 状态码和错误信息
  • 创建成功返回 201 状态码和内容
{
  "id": 1,
  "name": "Zealot",
  "schemes": []
}

更新应用信息​

使用应用 ID 更新应用信息

PUT /api/apps/:id

参数​

信息

需要用户认证

名称类型是否必须描述
idIntegertrueID
nameStringtrue应用名称

返回样例​

  • 应用不存在返回 404 状态码和错误信息

版本存在返回：

{
  "id": 1,
  "name": "New Zealot",
  "schemes": []
}

删除应用​

删除应用会删除应用下的所有类型，渠道和所有版本，包括应用的图标和安装包。

DELETE /api/apps/:id

参数​

信息

需要用户认证

名称类型是否必须描述
idIntegertrueID

返回样例​

  • 应用不存在返回 404 状态码和错误信息
  • 成功操作返回 200 状态码和错误信息