API Update-Endpoint

Hier ist ein Beispiel für code in JavaScript, um ein Update an das Plugin zu senden

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

Response-Format

Für unverschlüsselte Bundles, dein Endpoint sollte Folgendes zurückgeben:

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

Für verschlüsselte Bundles, musst du zusätzlich den Session-Key angeben:

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

Falls kein Update oder Fehler auftritt, füge message Key und optional ein error:

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

Feldbeschreibungen

• checksum: SHA256-Hash deiner Bundle-Zip-Datei zur Integritätsprüfung
• session_key: Nur bei verschlüsselten Bundles erforderlich – dies ist der ivSessionKey Wert, der vom encrypt-Befehl zurückgegeben wird
• version: Versionsbezeichner im semver-Format
• url: HTTPS-URL, über die das Bundle heruntergeladen werden kann

Bundle-Erstellung

Wie du kompatible Bundles erstellst und Checksummen generierst, erfährst du in der Auto-Update-Dokumentation.

Für verschlüsselte Bundles siehe die Dokumentation zu Encrypted Bundles die den vollständigen Encryption-Workflow erklärt.

Weiter geht's vom Update API Endpoint

Wenn du es nutzt API Update-Endpoint um CI/CD-Automatisierung zu planen, verbinde es mit Verwendung von @capgo/capacitor-updater für die native Funktion in der Verwendung von @capgo/capacitor-updater, Capgo CI/CD für den Produkt-Workflow in Capgo CI/CD, Capgo Native Builds optimieren für den Produkt-Workflow in Capgo Native Builds, Capgo Integrationen für den Produkt-Workflow in Capgo Integrationen, und CI/CD-Integration für das Implementierungsdetail in der CI/CD-Integration.