Apps

Apps sind die grundlegenden Einheiten in Capgo. Jede App stellt eine einzigartige Capacitor-Anwendung dar, 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 stellt Ihre Capacitor-Anwendung dar und umfasst:

• App-ID: Eindeutiger Bezeichner für Ihre Anwendung
• : Lesbarer Name Ihrer Anwendung: Visuelle Identifikatoren für Ihre App im Dashboard
• : Visuelle Identifikatoren für Ihre App im Dashboard: Visuelle Identifikatoren für Ihre App im Dashboard
• Einstellungen: Einstellungen, die die Art der Updates steuern, die geliefert werden
• Eigentumsrechte: Informationen über Organisation und Benutzerzugriff
• Verwendungsstatistiken: Metriken über Installationen und Updates

Empfehlungen

1. Namenskonvention: Verwenden Sie klare, identifizierbare Namen für Ihre Apps
2. Sicherheit: Schützen Sie Ihre API-Schlüssel und Zugriffsberechtigungen
3. Organisation: Apps unter derselben Organisation gruppieren
4. Überwachung: Apps-Statistiken und -Leistung regelmäßig überprüfen
5. Sicherung: Konfigurations-Sicherungen für kritische Apps aufrechterhalten

Endpunkte

GET

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

Informationen zu Ihren Apps abrufen.

Abfrageparameter

• page: Optional. Seitennummer für die Paginierung
• limit: Optional. Anzahl der Ergebnisse pro Seite (Standard: 50)
• org_id: Optional. Apps durch Organisation ID filtern. Wenn nicht angegeben, werden Apps von allen Organisationen zurückgegeben, zu denen der Benutzer Zugriff hat

Für die Abrufung einer bestimmten App:

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

Antwortstyp

Hinweis: last_version bezieht sich auf das letzte Bundle (Version), das für die App hochgeladen wurde

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
}

Beispielanfrage

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

Beispielantwort

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

Eine neue App erstellen.

Anforderungskörper

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

Beispielanfrage

# 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/

Erfolgreiche Antwort

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

Ein bestehendes App aktualisieren. Die App-ID wird im URL-Pfad angegeben.

Anforderungskörper

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

Beispielanfrage

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

Erfolgsantwort

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

LÖSCHEN

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

Eine App und alle damit verbundenen Ressourcen löschen. Die App-ID wird im URL-Pfad angegeben. Verwenden Sie mit größter 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

Gemeinsame Fehlerfälle und ihre Antworten:

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

Gemeinsame Verwendungsfälle

1. Neue App erstellen

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

2. App-Konfiguration aktualisieren

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

3. Rückhalteregelung festlegen

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

4. Apps nach Organisation abrufen

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

Ressourcen-Verwaltung

1. Speicheroptimierung: Speicherverwaltung überwachen und geeignete Aufbewahrungsrichtlinien festlegen
2. Organisation: Gruppieren Sie verwandte Apps unter einer einzelnen Organisation
3. Zugriffssteuerung: Verwalten Sie, welche Teammitglieder Apps-Einstellungen ändern können
4. Backup-Strategie: Sichern Sie kritische App-Konfigurationen und -Einstellungen

Fortsetzen von Apps

Wenn Sie " Apps " verwenden, um Dashboard und API-Operationen zu planen, verbinden Sie sie mit API Übersicht für die Implementierungsdetails in API Übersicht Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel Geräte für die Implementierungsdetails in Geräte, und Pakete für die Implementierungsdetails in Pakete.