A un API JSON public une interface Capgo JSON publique permet aux logiciels d'échanger des données structurées à travers des requêtes et des réponses HTTP. Le Capgo’s API JSON typé, RESTful, donne aux équipes de CapacitorJS et Electron un contrôle programmatique sur les mises à jour en direct, les canaux, les ensembles et la livraison de dispositifs.
Table des matières
Understanding Capgo Public API JSON Fundamentals
Capgo isn’t a general-purpose data directory. Its public API JSON interface connects your build system with Capgo’s cloud delivery service, so release automation can publish and direct signed web bundles without waiting for App Store or Play review. REST uses familiar HTTP methods such as GET, POST, PUT, PATCH, et DELETEAvec le JSON servant souvent de format de réponse, comme expliqué dans cet article. guide de REST API de Postman.
Pour Capgo, JSON est le langage partagé entre les scripts d'automatisation, les tâches CI/CD, les clients TypeScript et la plateforme de livraison. Cette cohérence rend les payloads lisibles dans les journaux et faciles à valider avant le démarrage d'une mise à jour.
Ce que les contrôles de l'interface gèrent
Utilisez les points de terminaison JSON publics API pour gérer les ressources de mise en production, notamment :
- Les lotsles actifs web et les métadonnées qui composent une mise à jour déployable.
- Les canauxcomme des flux de mise en production, de préproduction, de bêta ou de version client spécifique.
- VersionsLesquelles identifient et suivent les builds affectés à ces canaux.
- Ciblage de l'appareil, which helps direct releases to selected platforms, app versions, operating systems, or metadata groups.
- les données d'observabilité, y compris l'adoption, les échecs, l'activité de retrait et l'état par appareil.
Une requête typique suit une séquence prévisible. Votre pipeline crée ou prépare un bundle, envoie des métadonnées JSON à Capgo, vérifie l'état retourné et affecte ensuite la mise à jour à un canal approprié. Une requête ultérieure peut confirmer quels appareils ont reçu la mise à jour.
Idée clé : Traitez Capgo JSON comme un contrat de gestion de version, et non simplement comme un format de données. Chaque champ doit supporter la publication, la cible, le suivi ou la récupération d'une mise à jour d'application.
Pourquoi les JSON typés sont utiles
Les payloads typés réduisent l'ambiguïté dans les bases de code TypeScript. Un identifiant de version devrait rester une chaîne, un drapeau de déploiement devrait rester un Boolean et un comptage d'appareils devrait rester numérique. Avant de connecter l'automatisation, définissez des interfaces pour les requêtes et les réponses, puis validez les champs requis et les valeurs nulles.
Lisez aussi : En savoir plus sur l'utilisation de TypeScript avec les API.
Conservez trois habitudes dans chaque intégration :
- Inspectez les codes de statut et les corps de réponse ensemblecar l'HTTP succès ne décrit peut-être pas la fin de la mise en production.
- Conservez les identifiants renvoyés., notamment les identifiants de bundle, de version et de canal, pour les appels ultérieurs.
- Log safely, en excluant les clés API et les données de l'appareil.
Les sections de référence suivantes utilisent cette base pour expliquer l'authentification, les charges de transfert, les schémas de canal, les requêtes de ciblage et les objets d'erreur. Pour les noms d'extrémités actuels et les définitions de champs, vérifiez la documentation de Capgo à l'adresse capgo.app.
{ "autorisation": "Bearer VOTRE_CAPGO_API_CLE", "contentType": "application/json", "accept": "application/json" }
{ "succès": true, "bundleId": "com.example.field-app", "version": "2.4.0", "statut": "uploadé", "bundleUuid": "identifiant de bundle généré", "createdAt": "2026-01-15T10:30:00Z" }
{ "versionParDéfaut": "2.4.3", "miseÀJourAutomatique": true, "protectionDeRollback": { "activé": true, "versionDeRétrogradation": "2.4.2" } }
{ "données": [ { "timestamp": "2026-02-04T09:00:00Z", "installs": 842, "rollbacks": 3, "erreurs": 11 }, { "timestamp": "2026-02-04T10:00:00Z", "installs": 1276, "rollbacks": 2, "erreurs": 8 } ], "résumé": { "totalInstalls": 2118, "totalRollbacks": 5, "totalErreurs": 19 } }
{ "erreur": { "code": "PARAMÈTRE INVALIDE", "message": "Le champ ‘version’ est requis", "champ": "version", "détails": { "attendu": "chaîne", "reçu": "null" } } }
{ “version”: “2.4.0”, “checksum”: “sha256-value”, “encryption”: true, “externalUrl”: “https://stockage.exemple/bundle.zip” }
