Apps

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

Comprendre les applications

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

• App ID : identifiant unique de votre application
• Nom : nom lisible de votre application
• Icônes : identifiants visuels de votre application dans le tableau de bord
• Configuration : paramètres qui contrôlent la manière dont les mises à jour sont fournies
• Propriété : informations sur l’organisation et l’accès des utilisateurs
• Statistiques d’utilisation : mesures sur les installations et les mises à jour

## meilleures pratiques

1. Convention de dénomination : utilisez des noms clairs et identifiables pour vos applications
2. Sécurité : protégez vos clés API et vos identifiants d’accès
3. Organisation : regroupez les applications associées sous la même organisation
4. Surveillance : vérifiez régulièrement les statistiques et les performances des applications
5. Sauvegarde : conservez les sauvegardes de configuration pour les applications critiques

Points de terminaison

OBTENIR

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

Récupérez des informations sur vos applications.

Paramètres de requête

• page : Facultatif. Numéro de page pour la pagination
• limit : Facultatif. Nombre de résultats par page (par défaut : 50)
• org_id : Facultatif. Filtrez les applications par ID d’organisation. S’il n’est pas fourni, renvoie 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 de l’URL : https://api.capgo.app/app/:app_id

Type de réponse

Remarque : last_version fait référence au dernier bundle (version) téléchargé 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 demande

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

POSTER

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/

Réponse réussie

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

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

Mettez à jour une application existante. L’ID de l’application est spécifié dans le chemin 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 réussie

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

Supprimez une application et toutes les ressources associées. L’ID de l’application est spécifié dans le chemin de l’URL. À utiliser avec une extrême prudence car cette action est irréversible.

Exemple de demande

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

Réponse réussie

{
  "status": "ok"
}

Gestion des erreurs

Scénarios d’erreur 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"
}

Cas d’utilisation courants

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 des 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 du stockage : surveillez l’utilisation du stockage et définissez des politiques de rétention appropriées.
2. Organisation : regroupez les applications associées sous une seule organisation
3. Contrôle d’accès : gérez les membres de l’équipe qui peuvent modifier les paramètres de l’application.
4. Stratégie de sauvegarde : sauvegardez les configurations et paramètres critiques des applications