メイン コンテンツにスキップ

APIエンドポイントの更新

GitHub

Here is an example of code in JavaScript to send an update to the plugin

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: '',
}
}
}

For 非暗号化のバンドル、あなたのエンドポイントは次のようになります:

{
"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 __CAPGO_KEEP_0__とoptionally __CAPGO_KEEP_1__を追加します。 error:

{
"message": "Version not found",
"error": "The backend crashed",
"version": "1.0.2",
}
  • checksum__CAPGO_KEEP_0__は、バンドル zip ファイルの SHA256 ハッシュで、整合性の確認に使用します。
  • session_key__CAPGO_KEEP_1__は、暗号化されたバンドル専用 - この値は、encrypt コマンドによって返されます。 ivSessionKey __CAPGO_KEEP_2__は、semver形式のバージョン識別子です。
  • version__CAPGO_KEEP_3__は、バンドルがダウンロードできるHTTPS URLです。 __CAPGO_KEEP_0__
  • url__CAPGO_KEEP_1__

__CAPGO_KEEP_0__の作成方法とチェックサムの生成については、 自動更新ドキュメントを参照してください.

暗号化されたバンドルについては、 暗号化されたバンドルに関するドキュメントを参照してください。 完全な暗号化フローについて説明しています。

APIエンドポイントから続けて

APIエンドポイントセクション

__CAPGO_KEEP_0__を使用している場合 APIエンドポイント __CAPGO_KEEP_0__エンドポイントとCI/CDの自動化を計画する場合に接続する @capgo/capacitor-updaterを使用します。 @capgo/capacitor-updaterのネイティブ機能を使用します。 Capgo CI/CDを使用します。 Capgo CI/CDの製品ワークフローを使用します。 Capgo Native Buildsを使用します。 Capgo Native Buildsの製品ワークフローを使用します。 Capgo Integrationsを使用します。 Capgo Integrationsの製品ワークフローを使用します。 CI/CD Integrationの実装詳細を使用します。 ページを編集します。