Applications

Les applications sont les entités de base dans Capgo. Chaque application représente une application Capacitor unique que vous pouvez gérer et mettre à jour à travers la plateforme. La fonctionnalité des applications API vous permet de créer, de récupérer, de mettre à jour et de supprimer les configurations d'applications.

Comprendre les applications

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

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

Meilleures Pratiques

1. Conventions de Nom: Utilisez des noms clairs et identifiables pour vos applications
2. Sécurité: Protégez vos API clés et vos informations d'accès
3. Organisation: Groupez les applications liées sous la même organisation
4. Surveillance: Vérifiez régulièrement les statistiques et les performances de vos applications
5. Sauvegarde: Maintenez des sauvegardes de configurations pour les applications critiques

Points de terminaison

GET

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

Récupérez des informations sur vos applications.

Paramètres de requête

• pagePage : Optionnel. Numéro de page pour la pagination
• limitRésultats par page : Optionnel. Nombre de résultats par page (par défaut : 50)
• org_idFiltrer les applications par ID d'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 d'application dans l'URL de chemin : https://api.capgo.app/app/:app_id

Type de réponse

Remarque : last_version se réfère à la dernière archive (version) chargée pour l'application.

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
}

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": [
    {
      "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.

__CAPGO_KEEP_0__

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 de succès

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

Mettre à jour

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

Mettre à jour une application existante. L'ID de l'application est spécifié dans le chemin d'accès de l'URL.

Corps de la demande

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

Exemple de demande

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

Réponse de succès

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

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 une extrême 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

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 l'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èsGérer lesquels membres d'équipe peuvent modifier les paramètres de l'application
4. Stratégie de sauvegardeSauvegarder les configurations et les paramètres de l'application critiques