Applicazioni

Apps are the foundational entities in Capgo. Each app represents a unique Capacitor application that you can manage and update through the platform. The Apps API allows you to create, retrieve, update, and delete app configurations.

Capire gli App

An app in Capgo represents your Capacitor application and includes:

• ID dell'applicazione: Identificatore univoco per la tua applicazione
• Nome: Nome leggibile dall'uomo della tua applicazione
• Icone: Identificatori visivi per l'app nel pannello di controllo
• Configurazione: Impostazioni che controllano come vengono consegnati gli aggiornamenti
• Proprietà: Informazioni di accesso dell'organizzazione e degli utenti
• Statistiche di utilizzo: Metriche sugli installi e gli aggiornamenti

Pratiche Ottimali

1. Convenzione di Nominazione: Utilizza nomi chiari e identificabili per le tue app
2. Sicurezza: Protect your API keys and access credentials
3. : Proteggi le tue chiavi __CAPGO_KEEP_0__ e le credenziali di accessoOrganizzazione
4. : Raggruppa le app correlate sotto la stessa organizzazioneMonitoraggio
5. : Controlla regolarmente le statistiche e le prestazioni delle appBackup dei dati di configurazione per le app critiche

Punti di accesso

Punti di accesso

https://api.capgo.app/app/

Recupera informazioni sulle tue app.

Parametri di query

• page: Opzionale. Numero di pagina per la paginazione
• limit: Opzionale. Numero di risultati per pagina (predefinito: 50)
• org_id: Opzionale. Filtra le app per ID di organizzazione. Se non fornito, restituisce le app da tutte le organizzazioni di cui l'utente ha accesso

Per ottenere una specifica app:

• Utilizza l'ID dell'app nella URL di percorso: https://api.capgo.app/app/:app_id

Tipo di Risposta

Nota: last_version si riferisce all'ultima bundle (versione) caricata per l'applicazione.

interface App {
  app_id: string
  block_provider_infra_requests: boolean
  created_at: string | null
  default_upload_channel: string
  icon_url: string
  id: string | null
  last_version: string | null // last bundle (version) name
  name: string | null
  owner_org: string
  retention: number
  transfer_history: Json[] | null
  updated_at: string | null
  user_id: string | null
}

Esempio di Richiesta

# Get all apps
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/"

# Get apps from a specific organization
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

# Get specific app
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/com.demo.app"

Esempio di Risposta

{
  "data": [
    {
      "block_provider_infra_requests": true,
      "app_id": "com.demo.app",
      "created_at": "2024-01-01T00:00:00Z",
      "default_upload_channel": "dev",
      "icon_url": "https://example.com/icon.png",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "last_version": "1.0.0",
      "name": "Demo App",
      "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
      "retention": 2592000,
      "transfer_history": null,
      "updated_at": "2024-01-01T00:00:00Z",
      "user_id": "6aa76066-55ef-4238-ade6-0b32334a4097"
    }
  ]
}

POST

https://api.capgo.app/app/

Crea una nuova app.

Corpo della richiesta

interface CreateApp {
  app_id: string
  name: string
  icon?: string
  owner_org: string
}

Esempio di richiesta

# Create new app
curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New App",
    "app_id": "com.demo.myapp", // this id is unique in Capgo This cannot be reused by any account.
    "icon": "https://example.com/icon.png",
    "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
  }' \
  https://api.capgo.app/app/

Risposta di successo

{
  "block_provider_infra_requests": true,
  "app_id": "My New App",
  "created_at": "2024-01-01T00:00:00Z",
  "default_upload_channel": "dev",
  "icon_url": "https://example.com/icon.png",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My New App",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
  "retention": 2592000,
  "updated_at": "2024-01-01T00:00:00Z"
}

PUT

https://api.capgo.app/app/:app_id

Aggiorna un'app esistente. L'ID dell'app è specificato nella path dell'URL.

Corpo della richiesta

interface UpdateApp {
  block_provider_infra_requests?: boolean
  name?: string
  icon?: string
  retention?: number
}

Esempio di richiesta

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "block_provider_infra_requests": true,
    "name": "Updated App Name",
    "icon": "https://example.com/updated-icon.png",
    "retention": 45
  }' \
  https://api.capgo.app/app/com.demo.app

Risposta di successo

{
  "app_id": "com.demo.app",
  "created_at": "2024-01-01T00:00:00Z",
  "default_upload_channel": "dev",
  "block_provider_infra_requests": true,
  "icon_url": "https://example.com/updated-icon.png",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Updated App Name",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
  "retention": 45,
  "updated_at": "2024-01-01T00:00:00Z"
}

DELETE

https://api.capgo.app/app/:app_id

Cancella un'app e tutte le relative risorse. L'ID dell'app è specificato nella path dell'URL. Utilizzare con estrema cautela poiché questa azione non può essere annullata.

Richiesta di Esempio

curl -X DELETE \
  -H "authorization: your-api-key" \
  https://api.capgo.app/app/com.demo.app

Risposta di Successo

{
  "status": "ok"
}

Gestione degli Errori

Scenari di errori comuni e le loro risposte:

// App not found
{
  "error": "App not found",
  "status": "KO"
}

// Duplicate custom ID
{
  "error": "Custom ID already in use",
  "status": "KO"
}

// Invalid parameters
{
  "error": "Invalid app configuration",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage app",
  "status": "KO"
}

// Organization access denied
{
  "status": "You do not have access to this organization"
}

Utilizzo comune

1. Crea nuova App

// Set up a new app
{
  "name": "Production App",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
}

2. Aggiorna configurazione App

// Change app name and icon
{
  "name": "Rebranded App Name",
  "icon": "https://example.com/new-icon.png"
}

3. Imposta politica di conservazione

// Configure automatic bundle cleanup
{
  "retention": 30 // Keep bundles for 30 days
}

4. Ottieni Applicazioni per Organizzazione

# List all apps in a specific organization
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

Gestione Risorse

1. Optimizzazione di Archiviazione: Monitorare l'uso di archiviazione e impostare le politiche di conservazione adeguate
2. Organizzazione: Raggruppare le app correlate sotto una singola organizzazione
3. Controllo di Accesso: Gestire quali membri del team possono modificare le impostazioni dell'app
4. Strategia di Backup: Salva le configurazioni e impostazioni dell'app critiche

Continua da Apps

Se stai utilizzando Applicazioni to plan dashboard and API operations, connect it with per pianificare la dashboard e le operazioni di API, connettilo con Panoramica di API per i dettagli di implementazione in Panoramica di __CAPGO_KEEP_0__ Introduzione API Keys Chiavi di API Dispositivi per i dettagli di implementazione in Dispositivi, e Bundle per i dettagli di implementazione in Bundle.