Saltare al contenuto

Aggiorna l'Endpoint API

GitHub

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

Per bundle non crittografati, il tuo endpoint dovrebbe restituire:

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

Per pacchetti crittografati, inoltre, è necessario includere la chiave della 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",
}
  • checksumCopia nel portapenne
  • session_key: Richiesto solo per pacchetti crittografati - si tratta di ivSessionKey ritornato dal comando di crittografia
  • version: Identificatore della versione in formato semver
  • url: URL HTTPS dove il pacchetto può essere scaricato

Per imparare a creare pacchetti compatibili e generare checksum, vedere la documentazione dell'aggiornamento automatico.

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

Se stai utilizzando Aggiornamento Endpoint di API 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 i dettagli di implementazione in Integrazione CI/CD.