Update API エンドポイント

codeの例は、JavaScriptでプラグインにアップデートを送信するために使用します。

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 encryptコマンドによって返される
• version: semver形式のバージョン識別子
• url: HTTPS URL からバンドルをダウンロードできる

バンドル作成

互換性のあるバンドルを作成し、チェックサムを生成する方法については、 自動更新ドキュメント.

暗号化されたバンドルの場合、 暗号化されたバンドルに関するドキュメント 暗号化フローを完全に説明している

アップデートAPIエンドポイントから続ける

あなたがCI/CD自動化を計画するために アップデートAPIエンドポイント を使用している場合、__CAPGO_KEEP_0__-updater Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, Capgo CI/CD for the product workflow in Capgo CI/CD, 「Capgo CI/CDのネイティブ機能を使用する」 Capgo CI/CD の製品ワークフローを使用する場合、Capgo CI/CD、 Capgo製品ワークフローにおけるCapgo統合と CI/CD統合 CI/CD統合の実装詳細