Organisations

Les organisations sont les entités de niveau supérieur dans Capgo. Elles vous permettent de grouper les applications, les membres d'équipe et les ressources sous un même drapeau. Chaque organisation peut avoir plusieurs membres avec des rôles et des permissions différents.

Utilisations courantes

• Créer une nouvelle organisation pour votre entreprise
• Gérer les paramètres de l'organisation
• Mettre à jour les informations de l'organisation
• Récupérer les détails de l'organisation

Points de terminaison

GET

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

Récupérer les informations de l'organisation. Si un identifiant est fourni dans les paramètres, renvoie une organisation unique. Sinon, renvoie toutes les organisations accessibles. orgId Paramètres de requête

Endpoints

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

Exemple de réponse

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

Mise à jour

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. NommerUtilisez des noms clairs et descriptifs pour les organisations
2. RôlesAttribuez des rôles appropriés aux membres de l'équipe
3. CourrielUtilisez un courriel de groupe pour le paramètre management_email afin d'éviter les problèmes liés aux changements d'adresse e-mail personnelle
4. LogoHébergez les logos sur un CDN fiable et utilisez des URL HTTPS