更新 API 接口

以下是 JavaScript 中 code 的示例，用于向插件发送更新

interface AppInfos {
  version_name: string
  version_build: string
  version_os: string
  custom_id?: string
  is_prod?: boolean
  is_emulator?: boolean
  plugin_version: string
  platform: string
  app_id: string
  device_id: string
}

export const handler: Handler = async (event) => {
  const body = JSON.parse(event.body || '{}') as AppInfos
  const {
    platform,
    app_id,
    version_os,
    device_id,
    version_name,
    version_build,
    plugin_version,
  } = body
  console.log('update asked', platform,
    app_id,
    version_os,
    device_id,
    version_name,
    version_build,
    plugin_version)
  if (version_name === '1.0.0') {
    return {
      version: '1.0.1',
      url: 'https://apiurl.com/mybuild_101.zip',
      checksum: 'sha256_checksum_of_bundle',
    }
  }
  else if (version_name === '1.0.1') {
    return {
      version: '1.0.2',
      url: 'https://apiurl.com/mybuild_102.zip',
      checksum: 'sha256_checksum_of_bundle',
    }
  }
  else {
    return {
      message: 'Error version not found'
      version: '',
      url: '',
    }
  }
}

响应格式

对于 非加密包, 你的端点应该返回:

{
  "version": "1.0.2",
  "url": "https://apiurl.com/mybuild_102.zip",
  "checksum": "sha256_checksum_of_bundle"
}

对于 加密的捆绑包, 你还需要包含会话密钥:

{
  "version": "1.0.2",
  "url": "https://apiurl.com/mybuild_102.zip",
  "checksum": "encrypted_checksum_from_encrypt_command",
  "session_key": "ivSessionKey_from_encrypt_command"
}

如果没有更新或错误, 添加 message 密钥, 可选地还包括 error:

{
  "message": "Version not found",
  "error": "The backend crashed",
  "version": "1.0.2",
}

字段描述

• checksum: 你的捆绑包 zip 文件的 SHA256 散列值, 用于完整性验证
• session_key: 必须填写的，只有在加密包中才会出现 - 这是 ivSessionKey 由加密命令返回的
• version: 在 的格式
• url: 包可以从这里下载的HTTPS URL

包创建

要了解如何创建兼容包并生成校验和，请参阅 自动更新文档.

对于加密包，请参阅 加密包文档 它解释了加密工作流的完整过程

继续从 API 更新端点

如果您正在使用 API 更新端点 计划 CI/CD 自动化时，连接它到 使用 @capgo/capacitor-updater 使用 @capgo/capacitor-updater 的本地能力 Capgo CI/CD Capgo CI/CD 流程 Capgo 原生构建 Capgo 原生构建流程 Capgo 集成 为Capgo集成中的产品工作流程 CI/CD集成 为CI/CD集成中的实现细节