Update 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"
}

For 暗号化されたバンドル、セッションキーも含めてください:

{
  "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 エンドポイントから続ける

アップデート __CAPGO_KEEP_0__ エンドポイントを使用している場合 アップデート API エンドポイント CI/CDの自動化を計画するには、__CAPGO_KEEP_0__ エンドポイントと接続する capgo/capacitor-updaterを使用する capgo/capacitor-updaterのネイティブ機能 Capgo CI/CD Capgo CI/CDの製品ワークフロー Capgo ネイティブビルド Capgo ネイティブビルドの製品ワークフロー Capgo インテグレーション Capgo製品ワークフローにおける統合 CI/CD統合 CI/CD統合の実装詳細