A Öffentliche API JSON Ein öffentlicher Capgo JSON-Schnittstelle ermöglicht es Software, strukturierte Daten über HTTP-Anfragen und -Antworten auszutauschen. Capgo’s getippter, REST-fähiger API gibt den CapacitorJS- und Electron-Teams programmatische Kontrolle über Live-Updates, Kanäle, Pakete und Gerätelieferungen.
Inhaltsverzeichnis
Verständnis der Capgo Öffentliche API JSON Grundlagen
Capgo ist keine allgemeine Datenbank. Seine öffentliche API JSON-Schnittstelle verbindet Ihr Build-System mit Capgo’s Cloud-Delivery-Dienst, so dass die Release-Automatisierung veröffentlichen und gerichtete Web-Pakete ohne Wartezeit auf App Store oder Play-Bewertung ausführen kann. REST verwendet bekannte HTTP-Methode wie GET, POST, PUT, PATCH und DELETE. GET, POST, PUT, PATCH und DELETEmit JSON als häufiger Antwortformat, wie im Artikel erklärt REST API-Leitfaden von Postman.
Für Capgo, ist JSON die gemeinsame Sprache zwischen Automatisierungsskripten, CI/CD-Jobs, TypeScript-Klienten und der Lieferplattform. Diese Konsistenz macht Payloads in Protokollen lesbar und ermöglicht es, sie vor dem Start eines Deployments zu validieren.
Wie die Schnittstelle gesteuert wird
Verwenden Sie die öffentlichen API-JSON-Endpunkte, um die betrieblichen Release-Ressourcen zu verwalten, einschließlich:
- Pakete, die Web-Ressourcen und -Metadaten, die einen deploybaren Update bilden.
- Kanäle, wie z.B. Staging, Beta, Produktions- oder Kunden-spezifische Release-Ströme.
- Ausgaben, die die Builds identifizieren und verfolgen, die denen Kanälen zugewiesen sind.
- Gerätezielgruppedie, die Releases auf ausgewählte Plattformen, App-Versionen, Betriebssysteme oder Metadatengruppen lenkt.
- Beobachtungsdateneinschließlich der Adoption, Fehlschläge, Rollover-Aktivitäten und der Gerätestatus pro Gerät.
Eine typische Anfrage folgt einer vorhersehbaren Sequenz. Ihre Pipeline erstellt oder bereitet ein Bundle vor, sendet JSON-Metadaten an Capgo, überprüft den zurückgegebenen Status und weist dann die Release einer geeigneten Kanal zu. Eine späteren Abfrage kann bestätigen, welche Geräte die Aktualisierung erhalten haben.
Hauptidee: Behandeln Sie die Capgo-JSON als einen Release-Kontrollvertrag, nicht nur als Datenformat. Jeder Feld sollte die Veröffentlichung, Zielsetzung, Überwachung oder Wiederherstellung einer Anwendungsaktualisierung unterstützen.
Wozu der Typisierte JSON hilft
Typisierte Payloads reduzieren die Ambiguität in TypeScript-Codebasen. Eine Versionsidentifikationsnummer sollte eine Zeichenkette bleiben, ein Rollout-Flag sollte ein Boolean bleiben und eine Geräteanzahl sollte eine Zahl bleiben. Bevor Sie die Automatisierung verbinden, definieren Sie Schnittstellen für Anfragen und Antworten, überprüfen Sie dann erforderliche Felder und nullable Werte.
Lesen Sie auch: Mehr über die Verwendung von TypeScript mit APIs erfahren.
Halten Sie drei Gewohnheiten in jeder Integration:
- Überprüfen Sie Statuscodes und Antwortkörper zusammen, weil der HTTP-Erfolg allein die erfolgreiche Bereitstellung nicht beschreiben mag.
- Die zurückgegebenen Identifikatoren speichern.Besonders die IDs von Bundle, Version und Kanal, für nachfolgende Aufrufe.
- Loggen Sie sicher.ausgenommen API-Schlüssel und sensitive Gerätedaten.
Die folgenden Referenzabschnitte verwenden diese Grundlage, um die Authentifizierung, die Upload-Payloads, die Kanal-Schemata, die Zielabfragen und die Fehlerobjekte zu erklären. Für die aktuellen Endpunktnamen und Felddefinitionen überprüfen Sie die Dokumentation von Capgo unter capgo.app.
{ "authorization": "Bearer YOUR_CAPGO_API_SCHLÜSSEL", "contentType": "application/json", "accept": "application/json" }
{ "Erfolg": true, "bundleId": "com.example.field-app", "version": "2.4.0", "status": "hochgeladen", "bundleUuid": "generierte-Bundle-Identifikator", "createdAt": "2026-01-15T10:30:00Z" }
{ "defaultVersion": "2.4.3", "autoUpdate": true, "rollbackProtection": { "aktiviert": true, "fallbackVersion": "2.4.2" } }
{ "Daten": [ { "Zeitstempel": "2026-02-04T09:00:00Z", "Installations": 842, "Rücksetzungen": 3, "Fehler": 11 }, { "Zeitstempel": "2026-02-04T10:00:00Z", "Installations": 1276, "Rücksetzungen": 2, "Fehler": 8 } ], "Zusammenfassung": { "gesamtInstalliert": 2118, "gesamtRücksetzungen": 5, "gesamtFehler": 19 } }
{ "Fehler": { "code": "INVALID_PARAMETER", "message": "Das Feld ‘version’ ist erforderlich", "feld": "version", "details": { "erwartet": "Zeichenfolge", "erhalten": "null" } } }
{"version": "2.4.0",\n"checksum": "sha256-value",\n"encryption": true,\n"externalUrl": ""https://storage.beispiel.de/bundle.zip” }
