L'endpoint de mise à jour API

Voici un exemple de code en JavaScript pour envoyer une mise à jour du 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: '',
    }
  }
}

Format de réponse

Pour les ensembles non chiffrés, votre point de terminaison doit retourner :

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

Pour Les bundles chiffrés, vous devez également inclure la clé de session :

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

Et si aucune mise à jour ou erreur, ajoutez le message clé et optionnellement un error:

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

Description des champs

• checksum: hachage SHA256 de votre fichier zip de bundle pour la vérification de l'intégrité
• session_key: Obligatoire uniquement pour les ensembles chiffrés - c'est ivSessionKey retourné par la commande de chiffrement
• version: Identifiant de version dans format semver
• url: URL HTTPS où l'ensemble peut être téléchargé

Création de l'ensemble

Pour apprendre à créer des ensembles compatibles et générer des checksums, consultez la documentation de l'auto-mise à jour.

Pour les ensembles chiffrés, consultez la documentation des ensembles chiffrés qui explique l'ensemble du workflow de chiffrement.

Continuez de là depuis l'API Endpoint de mise à jour

Si vous utilisez l'API Endpoint de mise à jour pour planifier l'automatisation CI/CD, connectez-l’à En utilisant @capgo/capacitor-mises-à-jour pour la capacité native en En utilisant @capgo/capacitor-mises-à-jours, Capgo Automatisation CI/CD pour le flux de travail du produit dans Capgo Automatisation CI/CD, Capgo Bâtiments natifs pour le flux de travail du produit dans Capgo Bâtiments natifs, Capgo Intégrations pour le flux de travail du produit dans Capgo Intégrations, et Intégration CI/CD pour le détail d'implémentation dans Intégration CI/CD.