Update API Endpoint

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 Bundlessollte 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 Pakete, Sie müssen auch die 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 Fehlermeldung, fügen Sie den message Schlüssel und optional einen error:

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

Abschnitt mit dem Titel „Feldbeschreibungen“

• checksum: Erforderlich nur für verschlüsselte Pakete - dies ist der
• session_key: Erforderlich nur für verschlüsselte Pakete - dies ist der ivSessionKey durch den Verschlüsselungsbefehl zurückgegeben
• version: Versionsidentifikator in semver-Format
• url: HTTPS-URL, an der das Bundle heruntergeladen werden kann

Bundle-Erstellung

Um zu erfahren, wie kompatible Bundles erstellt und Checksummen generiert werden können, siehe die Auto-Update-Dokumentation.

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

Bleiben Sie bei der Update API-Endpunkt

Wenn Sie "__CAPGO_KEEP_0__" verwenden Update API Endpoint um die CI/CD-Automatisierung zu planen, 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 CI/CD Integration für die Implementierungsdetails in der CI/CD Integration.