Endpoint update di API

Ecco un esempio di code in JavaScript per inviare un aggiornamento al 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: '',
    }
  }
}

Formato della risposta

Per bundle non criptati, il tuo endpoint dovrebbe restituire:

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

Per bundle criptati, devi anche includere la session key:

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

E se non ci sono update o errori, aggiungi la message chiave e, opzionalmente, una error:

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

Descrizione dei campi

• checksum: hash SHA256 del file zip del bundle per la verifica dell'integrità
• session_key: richiesto solo per i bundle criptati - questo è il ivSessionKey valore restituito dal comando encrypt
• version: identificativo della versione in formato semver
• url: URL HTTPS dove è possibile scaricare il bundle

Creazione del Bundle

Per imparare a creare bundle compatibili e generare checksum, consulta la documentazione Auto Update.

Per i bundle crittografati, consulta la documentazione Encrypted Bundles che spiega l'intero workflow di crittografia.

Continua dall'endpoint Update API

Se stai usando Endpoint update di API per pianificare l'automazione CI/CD e connetterla a Usando @capgo/capacitor-updater per la funzionalità nativa in Usando @capgo/capacitor-updater, CI/CD con Capgo per il workflow del prodotto in Capgo CI/CD, Capgo Native Build per il workflow di prodotto in Capgo Native Builds, Integrazioni Capgo per il workflow del prodotto nelle integrazioni Capgo, e Integrazione CI/CD per i dettagli di implementazione nell'integrazione CI/CD.