A public JSON API Une interface permet aux logiciels d'échanger des données structurées à travers des requêtes HTTP et des réponses. Capgo’s JSON typé, RESTful API donne aux équipes de CapacitorJS et d'Electron un contrôle programmable sur les mises à jour en direct, les canaux, les lots et la livraison des appareils.
Table des matières
Understanding Capgo Public API JSON Fundamentals
Capgo n'est pas un répertoire de données généraliste. Son interface JSON public API connecte votre système de construction avec le service de livraison cloud de Capgo, permettant ainsi à l'automatisation des publications et à la direction des paquets web signés sans attendre la revue de l'App Store ou de Play. GET, POST, PUT, PATCH et DELETE, avec JSON servant souvent de format de réponse, comme expliqué dans ce REST API guide from 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 le Contrôle Gère
Utilisez les points de terminaison JSON public API pour gérer les ressources de mise en production, notamment :
- Les paquets, les actifs web et les métadonnées qui composent une mise à jour déployable.
- Les canauxcomme par exemple des flux de versionnage de pré-production, de bêta, de production ou spécifiques à un client.
- Versionsqui identifient et suivent les builds affectés à ces canaux.
- ciblage de dispositif, which helps direct releases to selected platforms, app versions, operating systems, or metadata groups.
- 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 les appareils qui ont reçu la mise à jour.
Idee clé : Traitez Capgo JSON comme un contrat de contrôle 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 codebases TypeScript. Un identifiant de version devrait rester une chaîne, un drapeau de déploiement devrait rester un Boolean et un comptage de dispositif 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 ensemble, car le succès HTTP ne décrit peut-être pas la fin de la mise en production.
- Préservez les identifiants renvoyés, notamment les identifiants de bundle, de version et de canal, pour les appels ultérieurs.
- Log safely, excluant les clés API et les données de l'appareil sensible.
Les sections de référence suivantes utilisent cette base pour expliquer l'authentification, les chargements de payloads, les schémas de canal, les requêtes de ciblage et les objets d'erreur. Pour les noms d'endpoints actuels et les définitions de champs, vérifiez la documentation de Capgo à l'adresse capgo.app.
{"authorization": "Bearer YOUR_CAPGO_API_KEY", "contentType": "application/json", "accept": "application/json" }
{ “succès” : vrai, “idBundle” : “com.example.field-app”, “version” : “2.4.0”, “statut” : “uploadé”, “uuidBundle” : “identifiant-génére-bundle”, “createdAt” : “2026-01-15T10:30:00Z” }
{ “versionParDéfaut” : “2.4.3”, “miseÀJourAutomatique” : true, “protectionDeRollback” : { “activé” : true, “versionDeRemplacement” : “2.4.2” } }
{ “data”: [ { “timestamp”: “2026-02-04T09:00:00Z”, “installs”: 842, “rollbacks”: 3, “errors”: 11 }, { “timestamp”: “2026-02-04T10:00:00Z”, “installs”: 1276, “rollbacks”: 2, “errors”: 8 } ], “summary”: { “totalInstalls”: 2118, “totalRollbacks”: 5, “totalErrors”: 19 } }
{ “erreur” : { “code” : “PARAMÈTRE INVALIDE”, “message” : “Le champ ‘version’ est requis”, “champ” : “version”, “détails” : { “attendu” : “chaîne de caractères”, “reçu” : “null” } } }
{ “version”: “2.4.0”, “checksum”: “sha256-value”, “encryption”: true, “externalUrl”: “https://stockage.exemple/bundle.zip” }
