Update API Endpoint

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 i pacchetti non crittografatiil tuo endpoint dovrebbe restituire:

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

Per i pacchetti crittografatidovrai anche includere la chiave di sessione:

{
  "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 aggiornamenti o errori, aggiungi il message chiave e facoltativamente un error:

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

Descrizioni del campo

• checksum: Hash SHA256 del file zip del pacchetto per la verifica dell'integrità
• session_key: Richiesto solo per i pacchetti crittografati - è il ivSessionKey ritornato dal comando di crittografia
• version: Identificatore della versione in formato semver
• url: URL HTTPS dove il pacchetto può essere scaricato

Creazione del Pacchetto

Per imparare a creare pacchetti compatibili e generare checksum, vedere la documentazione di Aggiornamento Automatico.

Per i pacchetti crittografati, vedere la documentazione di Pacchetti Crittografati che spiega il flusso di crittografia completo.

Continua con l'Endpoint di Aggiornamento API

Se stai utilizzando Aggiornamento API Endpoint per pianificare l'automazione CI/CD, connettilo con Usando @capgo/capacitor-aggiornatore per la capacità nativa in Usando @capgo/capacitor-aggiornatore, Capgo CI/CD per il flusso di lavoro del prodotto in Capgo CI/CD, Capgo Costruzioni native per il flusso di lavoro del prodotto in Capgo Costruzioni native, Capgo Integrazioni per il flusso di lavoro del prodotto in Capgo Integrazioni, e Integrazione CI/CD per la dettaglio di implementazione in Integrazione CI/CD.