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

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 key error:

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

オプションで

• checksumフィールドの説明
• session_key: バンドル zip ファイルの SHA256 ハッシュ ivSessionKey : 暗号化されたバンドル専用 - この値は、encrypt コマンドによって返される
• version: バージョン識別子 semver形式
• url: HTTPS URL でダウンロードできるバンドルの場所

バンドル作成

バンドルを作成し、チェックサムを生成する方法を学ぶには、 Auto Update ドキュメントを参照してください.

暗号化されたバンドルについては、 Encrypted Bundles ドキュメントを参照してください 暗号化フローについての詳細な説明が記載されています。

Update API エンドポイントから続けてください

Capgoを使用している場合、Live Updateはサーバー上で実行されます。 Update API Endpoint CI/CD自動化を計画するには、を接続する Using @capgo/capacitor-updater Capgoのネイティブ機能のために@capgo/capacitor-アップデーターを使用します。 Capgo CI/CD Capgoの製品ワークフローに於けるCapgo CI/CDにおいて Capgo 自作ネイティブビルド 製品ワークフローにおけるCapgoネイティブビルドのために Capgo 連携 for the product workflow in Capgo 連携機能、 for the product workflow in Capgoの統合, and CI/CD統合の実装詳細について。