Applications

Les apps sont les entités fondamentales de Capgo. Chaque app représente une application Capacitor unique que vous pouvez gérer et mettre à jour via la plateforme. L'API des apps vous permet de créer, récupérer, modifier et supprimer les configurations d'app.

Comprendre les apps

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

• ID de l'app: identifiant unique de votre application
• Nom: nom lisible de votre application
• Icônes: Identifiants visuels de votre app dans le dashboard
• Configuration: Paramètres de distribution des mises à jour
• Propriété: Informations sur l'organisation et l'accès utilisateur
• Statistiques d'usage: Métriques sur les installations et les mises à jour

Bonnes pratiques

1. Convention de nommage: Utilisez des noms clairs et identifiables pour vos apps
2. Sécurité: Protégez vos clés API et vos identifiants d'accès
3. Organisation: Regroupez les applications liées sous la même organisation
4. Suivi: Consultez régulièrement les statistiques et les performances de l’app
5. Sauvegarde: Maintenez des sauvegardes de configuration pour vos apps critiques

Endpoints

GET

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

Récupérer des informations sur vos apps.

Paramètres de requête

• page: Optionnel. Numéro de page pour la pagination
• limit: Optionnel. Nombre de résultats par page (par défaut : 50)
• org_id: Optionnel. Filtrez les apps par ID d'organisation. Si non fourni, renvoie les apps de toutes les organisations auxquelles l'utilisateur a accès

Pour récupérer une app spécifique :

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

Type de réponse

Note : last_version fait référence au dernier bundle (version) envoyé pour l'app.

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"

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éer une nouvelle application.

Corps de la requête

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

Exemple de requête

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

Réponse en cas 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"
}

PUT

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

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

Corps de la requête

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

Exemple de requête

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 en cas 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

Supprime une application et toutes les ressources associées. L'ID de l'application est indiqué dans le chemin de l'URL. À utiliser avec une extrême prudence, car cette action est irréversible.

Exemple de requête

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

Réponse en cas de succès

{
  "status": "ok"
}

Gestion des erreurs

Toutes les erreurs utilisent le format d'erreur standard décrit dans la Aperçu de API.

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

// Missing or invalid API key (HTTP 401)
{
  "error": "invalid_apikey",
  "message": "Invalid apikey",
  "moreInfo": {}
}

// app_id is not a reverse-domain identifier
{
  "error": "invalid_app_id",
  "message": "App ID must be a reverse domain string",
  "moreInfo": { "app_id": "my app" }
}

// The API key has no access to this app (HTTP 401)
{
  "error": "cannot_access_app",
  "message": "You can't access this app",
  "moreInfo": { "app_id": "com.example.app" }
}

// Creating an app in an organization the key cannot write to (HTTP 403)
{
  "error": "cannot_access_organization",
  "message": "You can't access this organization",
  "moreInfo": { "org_id": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }
}

// Retention above the two-year limit on update
{
  "error": "retention_to_big",
  "message": "Retention cannot be bigger than 63113903 (2 years)",
  "moreInfo": { "retention": 99999999 }
}

Cas d'usage courants

1. Créer une nouvelle app

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

2. Mettre à jour la configuration de l'app

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

3. Définir la politique de rétention

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

4. Récupérer les apps 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 du stockage: Surveillez l'utilisation du stockage et définissez des politiques de rétention adaptées
2. Organisation: Regroupez les applications liées sous une seule organisation
3. Contrôle d’accès: Gérez les membres de l'équipe autorisés à modifier les paramètres de l'app
4. Stratégie de sauvegarde: Sauvegardez les configurations et les paramètres critiques de l'app

Continuer depuis Apps

Si vous utilisez Applications pour planifier les opérations du dashboard et de API, connectez-l’avec Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans API Keys, Appareils pour les détails d'implémentation dans Devices, et Les bundles pour les détails d'implémentation dans Bundles.