Applicazioni

Gli App sono le entità fondamentali in Capgo. Ogni app rappresenta un'applicazione Capacitor unica che puoi gestire e aggiornare tramite la piattaforma. La sezione degli App API ti consente di creare, recuperare, aggiornare e eliminare le configurazioni delle app.

Capire gli App

Un'app in Capgo rappresenta la tua applicazione Capacitor e include:

• ID App: Identificatore univoco per la tua applicazione
• Nome: Nome leggibile dell'applicazione
• Icone: Identificatori visivi per l'app nel dashboard
• Configurazione: Impostazioni che controllano come vengono distribuiti gli aggiornamenti
• Proprietà: Informazioni di accesso dell'organizzazione e degli utenti
• Statistiche di Utilizzo: Metriche sugli installi e gli aggiornamenti

Prassi Raccomandate

1. Convenzione di Nominazione: Utilizza nomi chiari e identificabili per le tue app
2. Sicurezza: Proteggi le tue API chiavi e le credenziali di accesso
3. Organizzazione: Raggruppa le app correlate sotto la stessa organizzazione
4. Monitoraggio: Controlla regolarmente le statistiche e le prestazioni delle app
5. Backup: Mantieni backup delle configurazioni per le app critiche

Punti di Fine

Esegui GET

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

Recupera informazioni sui tuoi app.

Parametri della 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 dell'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
  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": [
    {
      "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

{
  "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 della URL.

Corpo della richiesta

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

Esempio di richiesta

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "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",
  "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"
}

Elimina

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

Elimina un'applicazione e tutti i relativi risorse. L'ID dell'applicazione è specificato nella path della 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 dell'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 App 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 del Storage: Monitorare l'uso del storage e impostare politiche di conservazione adeguate
2. Organizzazione: Raggruppare le app correlate sotto una singola organizzazione
3. Controllo dell'Accesso: Gestire quali membri del team possono modificare le impostazioni dell'app
4. Strategia di Backup: Eseguire backup delle configurazioni e impostazioni dell'app critiche