Guida di riferimento pubblica Capgo API JSON

A un'interfaccia pubblica API JSON interface lets software exchange structured data through HTTP requests and responses. Capgo’s typed, RESTful API gives CapacitorJS and Electron teams programmatic control over live updates, channels, bundles, and device delivery.

Elenco dei contenuti

• Understanding Capgo Public API JSON Fundamentals
  • Capire i fondamenti di __CAPGO_KEEP_0__ Pubblico __CAPGO_KEEP_1__ JSON
  • Quello che l'interfaccia controlla

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, e DELETEcon JSON, che è comunemente utilizzato come formato di risposta, come spiegato in questo Guida REST API da Postman.

Per Capgo, JSON è il linguaggio condiviso tra gli script di automazione, le attività CI/CD, i client TypeScript e la piattaforma di consegna. Quella coerenza rende i payload leggibili nei log e facile da validare prima che un'installazione inizi.

Cosa controlla l'interfaccia

Utilizza gli endpoint JSON pubblici API per gestire le risorse di rilascio operativo, tra cui:

• Pacchetti, i beni web e i metadati che compongono un aggiornamento distribuibile.
• Canalicome ad esempio flussi di rilascio di staging, beta, produzione o specifici per i clienti.
• Versioni, che identificano e tracciano i build assegnati a quei canali.
• Target di dispositivoche aiuta a dirigere le rilasci verso piattaforme selezionate, versioni di app, sistemi operativi o gruppi di metadati.
• i dati di osservabilitàInclusi adozioni, fallimenti, attività di rollback e stato per dispositivo.

Una richiesta tipica segue una sequenza predittiva. La tua pipeline crea o prepara un bundle, invia i metadati JSON a Capgo, controlla lo stato restituito e assegna quindi il rilascio a un canale appropriato. Una successiva query può confermare quali dispositivi hanno ricevuto l'aggiornamento.

Idea chiave: Trattare Capgo JSON come un contratto di controllo delle release, non solo come un formato di dati. Ogni campo dovrebbe supportare la pubblicazione, la destinazione, la monitoraggio o il recupero di un aggiornamento dell'applicazione.

Perché i JSON tipizzati aiutano

Il payload tipizzato riduce l'ambiguità nei codici TypeScript. Un identificatore di versione dovrebbe rimanere una stringa, un flag di distribuzione dovrebbe rimanere un Boolean e un conteggio di dispositivi dovrebbe rimanere numerico. Prima di collegare l'automazione, definisci gli interfacce per le richieste e le risposte, quindi valuta i campi richiesti e i valori nullabili.

Leggi anche: Scopri di più sull'utilizzo di TypeScript con le API.

Conserva tre abitudini in ogni integrazione:

1. Ispeziona codici di stato e corpi di risposta insiemeperché il successo HTTP da solo non descrive la completa conclusione della distribuzione.
2. Preservare gli identificatori restituitispecialmente gli ID bundle, versione e canale, per chiamate successive.
3. Log safelyescludendo le chiavi API e i dati sensibili del dispositivo.

I seguenti sezioni di riferimento utilizzano questa base per spiegare l'autenticazione, gli payload di caricamento, le schemi di canale, le query di targeting e gli oggetti di errore. Per i nomi attuali degli endpoint e le definizioni dei campi, verificare la documentazione di Capgo su capgo.app.

{\n“autenticazione”: “Bearer YOUR_CAPGO_API_KEY”,\n“contentType”: “application/json”,\n“accetta”: “application/json”\n}

{ “success”: true, “bundleId”: “com.example.field-app”, “version”: “2.4.0”, “status”: “uploaded”, “bundleUuid”: “identificatore-bundle-generato”, “createdAt”: “2026-01-15T10:30:00Z” }

{ “versionPredefinita”: “2.4.3”, “aggiornamentoAutomatico”: vero, “protezioneRitornoIndietro”: { “abilitato”: vero, “versioneFallback”: “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 } }

{ “error”: { “code”: “INVALID_PARAMETER”, “message”: “Il campo ‘versione’ è richiesto”, “field”: “versione”, “details”: { “expected”: “string”, “received”: “null” } } }

{ “version”: “2.4.0”, “checksum”: “sha256-value”, “cifra”: true, “urlEsterno”: “https://storage.esempio.it/bundle.zip” }