Organisations

Organizations are the top-level entities in Capgo. They allow you to group apps, team members, and resources under a single umbrella. Each organization can have multiple members with different roles and permissions.

Utilisations courantes

• Créer une nouvelle organisation pour votre entreprise
• Gestion des paramètres d'organisation
• Mise à jour des informations d'organisation
• Récupération des détails d'organisation

Points de terminaison

GET

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

Récupérer les informations d'organisation. Si un identifiant est fourni dans les paramètres, renvoie une organisation unique. Sinon, renvoie toutes les organisations accessibles. orgId Récupérer les informations d'organisation. Si un identifiant est fourni dans les paramètres, renvoie une organisation unique. Sinon, renvoie toutes les organisations accessibles.

Paramètres de requête

• orgId (facultatif) L'ID de l'organisation spécifique à récupérer

Type de réponse

interface Organization {
  id: string
  created_by: string
  created_at: string
  updated_at: string
  logo: string | null
  name: string
  management_email: string
  customer_id: string | null
}

Exemple de requête

# Get all organizations
curl -H "authorization: your-api-key" https://api.capgo.app/organization/

# Get specific organization
curl -H "authorization: your-api-key" https://api.capgo.app/organization/?orgId=org_123

Exemple de réponse

{
  "data": {
    "id": "org_123",
    "name": "My Company",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "logo": "https://example.com/logo.png",
    "management_email": "admin@example.com",
    "customer_id": "cus_123"
  }
}

POST

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

Créer une nouvelle organisation.

Corps de la demande

interface OrganizationCreate {
  name: string
}

Exemple de demande

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Organization"
  }' \
  https://api.capgo.app/organization/

Réponse d'exemple

{
  "status": "Organization created",
  "id": "org_456"
}

PUT

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

Mettre à jour une organisation existante. Exige le rôle d'administrateur.

Corps de la demande

interface OrganizationUpdate {
  orgId: string
  logo?: string
  name?: string
  management_email?: string
}

Exemple de demande

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "orgId": "org_123",
    "name": "New Company Name",
    "management_email": "newemail@example.com"
  }' \
  https://api.capgo.app/organization/

Réponse d'exemple

{
  "status": "Organization updated",
  "data": {
    "id": "org_123",
    "name": "New Company Name",
    "management_email": "newemail@example.com"
  }
}

SUPPRIMER

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

Supprimer une organisation existante. Exige le rôle d'administrateur. Cette action est irréversible et supprimera tous les applications associées, les lots (versions) et les ressources.

Paramètres de requête

• orgId : L'ID de l'organisation à supprimer

Exemple de requête

curl -X DELETE \
  -H "authorization: your-api-key" \
  https://api.capgo.app/organization/?orgId=org_123

Réponse d'exemple

{
  "status": "Organization deleted",
  "id": "org_123"
}

Gestion des erreurs

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

// Invalid API key
{
  "error": "Invalid API key",
  "status": "KO"
}

// Missing required field
{
  "error": "Name is required",
  "status": "KO"
}

// Insufficient permissions
{
  "error": "Admin role required",
  "status": "KO"
}

Meilleures pratiques

1. Nommer : Utilisez des noms clairs et descriptifs pour les organisationsCopier dans le presse-papier
2. Rôles: Assigner les rôles appropriés aux membres de l'équipe
3. Courriel: Utiliser un courriel de groupe pour le paramètre management_email afin d'éviter les problèmes liés aux changements d'adresse email personnelle
4. Logo: Héberger les logos sur un CDN fiable et utiliser des URL HTTPS

Continuez avec les Organisations

Si vous utilisez Organisations pour planifier le tableau de bord et les opérations API , connectez-le avec API Vue d'ensemble pour les détails d'implémentation dans API Vue d'ensemble Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés Appareils pour les détails d'implémentation dans Appareils, et Bundles pour les détails d'implémentation dans Bundles.