Apps

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.

Comprendre les applications

Une application dans Capgo représente votre Capacitor et comprend :

• App ID: Identifiant unique pour votre application
• Nom: Nom humain lisible de votre application
• Icônes: Identifiants visuels pour votre application dans le tableau de bord
• Configuration: Paramètres qui contrôlent la livraison des mises à jour
• Propriété: Informations sur l'organisation et l'accès des utilisateurs
• Statistiques d'utilisation: Métriques sur les installations et les mises à jour

Meilleures pratiques

1. Convention de NomUtilisez des noms clairs et identifiables pour vos applications
2. SécuritéProtégez vos clés et vos informations d'identification API
3. OrganisationGroupez les applications liées sous la même organisation
4. Surveillance: Regularly check app statistics and performance
5. Sauvegarde: Sauvegardez des copies de configuration pour les applications critiques

Endpoints

GET

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

Récupérez des informations sur vos applications.

Paramètres de requête

• page: Nombre de page facultatif pour la pagination
• limit: Nombre de résultats par page facultatif (par défaut : 50)
• org_id: Facultatif. Filtrer les applications par l'ID de l'organisation. Si non fourni, retourne les applications de toutes les organisations auxquelles l'utilisateur a accès.

Pour obtenir une application spécifique :

• Utilisez l'ID de l'application dans le chemin d'URL : https://api.capgo.app/app/:app_id

Type de réponse

Note : last_version fait référence à la dernière mise à jour de l'application (version) uploadée.

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
}

Exemple de requête

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

Section intitulée « Exemple de réponse »

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

Créez une nouvelle application.

Corps de la demande

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

Exemple de demande

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

Section intitulée “Réponse de succès”

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

Mise à jour

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

Update an existing app. The app ID is specified in the URL path.

Corps de la demande

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

Exemple de demande

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

Réponse de succès

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

SUPPRIMER

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

Supprimer une application et toutes les ressources associées. L'ID de l'application est spécifié dans l'URL de chemin. Utilisez avec prudence, car cette action ne peut pas être annulée.

Exemple de requête

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

Section intitulée « Réponse de succès »

{
  "status": "ok"
}

Gestion des Erreurs

Scénarios d'erreurs courants et leurs réponses :

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

Utilisations courantes

1. Créer une nouvelle application

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

2. Mettre à jour la configuration de l'application

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

3. Définir la politique de conservation

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

4. Obtenir les applications par organisation

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

Gestion des ressources

1. Optimisation de stockageSurveiller l'utilisation de stockage et définir des politiques de conservation appropriées
2. OrganisationGrouper les applications liées sous une seule organisation
3. Contrôle d'accès: Manage which team members can modify app settings
4. Stratégie de sauvegardeSauvegarder les configurations et les paramètres critiques de l'application

Continuez de là depuis les Applications

Si vous utilisez Applications planifier le tableau de bord et les opérations API, connectez-l’avec API Présentation pour les détails d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans l'Introduction. Clés API pour les détails d'implémentation dans les clés API Devices pour les détails d'implémentation dans les appareils, et Bundles pour les détails d'implémentation dans les Bundles.