Apps

Apps sind die grundlegenden Entitäten in Capgo. Jede App repräsentiert eine einzigartige Capacitor-Anwendung, die Sie über die Plattform verwalten und aktualisieren können. Die Apps-API ermöglicht es Ihnen, App-Konfigurationen zu erstellen, abzurufen, zu aktualisieren und zu löschen.

Apps verstehen

Eine App in Capgo repräsentiert Ihre Capacitor-Anwendung und umfasst:

• App ID: Eindeutiger Identifikator für Ihre Anwendung
• Name: Lesbarer Name Ihrer Anwendung
• Icons: Visuelle Identifikatoren für Ihre App im Dashboard
• Konfiguration: Einstellungen, die steuern, wie Updates bereitgestellt werden
• Eigentum: Organisations- und Benutzerzugriffsinformationen
• Nutzungsstatistiken: Metriken zu Installationen und Updates

Best Practices

1. Namenskonvention: Verwenden Sie klare, identifizierbare Namen für Ihre Apps
2. Sicherheit: Schützen Sie Ihre API-Schlüssel und Zugangsberechtigungen
3. Organisation: Gruppieren Sie verwandte Apps unter derselben Organisation
4. Überwachung: Überprüfen Sie regelmäßig App-Statistiken und -Leistung
5. Backup: Pflegen Sie Konfigurations-Backups für kritische Apps

Endpunkte

GET

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

Abrufen von Informationen über Ihre Apps.

Query-Parameter

• page: Optional. Seitennummer für Paginierung
• limit: Optional. Anzahl der Ergebnisse pro Seite (Standard: 50)
• org_id: Optional. Filtern von Apps nach Organisations-ID. Falls nicht angegeben, werden Apps aus allen Organisationen zurückgegeben, auf die der Benutzer Zugriff hat

Um eine bestimmte App abzurufen:

• Verwenden Sie die App-ID im URL-Pfad: https://api.capgo.app/app/:app_id

Antworttyp

interface App {
  app_id: string
  created_at: string | null
  default_upload_channel: string
  icon_url: string
  id: string | null
  last_version: string | null
  name: string | null
  owner_org: string
  retention: number
  transfer_history: Json[] | null
  updated_at: string | null
  user_id: string | null
}

Beispielanfrage

# Alle Apps abrufen
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/"

# Apps von einer bestimmten Organisation abrufen
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

# Bestimmte App abrufen
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/com.demo.app"

Beispielantwort

{
  "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/

Erstellen Sie eine neue App.

Request Body

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

Beispielanfrage

# Neue App erstellen
curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New App",
    "app_id": "com.demo.myapp", // diese ID ist einzigartig in Capgo und kann von keinem Account wiederverwendet werden.
    "icon": "https://example.com/icon.png",
    "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
  }' \
  https://api.capgo.app/app/

Erfolgsantwort

{
  "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

Aktualisieren Sie eine bestehende App. Die App-ID wird im URL-Pfad angegeben.

Request Body

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

Beispielanfrage

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

Erfolgsantwort

{
  "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"
}

DELETE

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

Löschen Sie eine App und alle zugehörigen Ressourcen. Die App-ID wird im URL-Pfad angegeben. Verwenden Sie dies mit äußerster Vorsicht, da diese Aktion nicht rückgängig gemacht werden kann.

Beispielanfrage

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

Erfolgsantwort

{
  "status": "ok"
}

Fehlerbehandlung

Häufige Fehlerszenarien und ihre Antworten:

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

// Doppelte benutzerdefinierte ID
{
  "error": "Custom ID already in use",
  "status": "KO"
}

// Ungültige Parameter
{
  "error": "Invalid app configuration",
  "status": "KO"
}

// Berechtigung verweigert
{
  "error": "Insufficient permissions to manage app",
  "status": "KO"
}

// Organisationszugriff verweigert
{
  "status": "You do not have access to this organization"
}

Häufige Anwendungsfälle

1. Neue App erstellen

// Neue App einrichten
{
  "name": "Production App",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
}

2. App-Konfiguration aktualisieren

// App-Name und Icon ändern
{
  "name": "Rebranded App Name",
  "icon": "https://example.com/new-icon.png"
}

3. Aufbewahrungsrichtlinie festlegen

// Automatische Bundle-Bereinigung konfigurieren
{
  "retention": 30 // Bundles 30 Tage aufbewahren
}

4. Apps nach Organisation abrufen

# Alle Apps in einer bestimmten Organisation auflisten
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

Ressourcenverwaltung

1. Speicheroptimierung: Überwachen Sie die Speichernutzung und legen Sie angemessene Aufbewahrungsrichtlinien fest
2. Organisation: Gruppieren Sie verwandte Apps unter einer einzigen Organisation
3. Zugriffskontrolle: Verwalten Sie, welche Teammitglieder App-Einstellungen ändern können
4. Backup-Strategie: Sichern Sie kritische App-Konfigurationen und -Einstellungen