Update API-Endpunkt

Hier ist ein Beispiel für code in JavaScript, um eine Aktualisierung 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: '',
    }
  }
}

Antwortformat

Für nicht verschlüsselte Bundles, sollte Ihr Endpunkt folgendes zurückgeben:

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

Für verschlüsselte Bundles, müssen Sie auch den Sitzungsschlüssel einbeziehen:

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

Und wenn keine Aktualisierung oder Fehler, fügen Sie den message __CAPGO_KEEP_0__ und optional einen error:

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

Feldbeschreibungen

• checksumSHA256-HASH Ihres Bundle-ZIP-Dateis für die Integritätsüberprüfung
• session_keyWird nur für verschlüsselte Bundle benötigt - dies ist das ivSessionKey von der Kommandozeilenanweisung zurückgegebene
• versionVersionenidentifikator in semver-Format
• urlHTTPS-URL, an dem das Bundle heruntergeladen werden kann

Bundle Erstellung

Um zu erfahren, wie man kompatible Bundles erstellt und Prüfsummen generiert, siehe die Auto-Update-Dokumentation.

Für verschlüsselte Bundles siehe die Dokumentation zu verschlüsselten Bundles welche die komplette Verschlüsselungsworkflow erklärt.

Weitermachen von Update API Endpoint

Wenn Sie Update API Endpoint zum Planen von CI/CD-Automatisierung verwenden, verbinden Sie es mit Mit @capgo/capacitor-Updater für die native Fähigkeit in Mit @capgo/capacitor-Updater, Capgo CI/CD für den Produktworkflow in Capgo CI/CD, Capgo Native Builds für den Produktworkflow in Capgo Native Builds, Capgo Integrations für den Produktworkflow in Capgo Integrations, und CI/CD-Integration für die Implementierungsdetails in CI/CD-Integration.