Organizations

Les organisations sont les entités de niveau supérieur dans Capgo. Ils vous permettent de regrouper les applications, les membres de l’équipe et les ressources sous un même toit. Chaque organisation peut avoir plusieurs membres avec différents rôles et autorisations.

Cas d’utilisation courants

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

Points de terminaison

OBTENIR

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

Récupérer les informations de l’organisation. Si orgId est fourni dans les paramètres, renvoie une seule organisation. 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 demande

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

POSTER

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

Créez 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"
}

METTRE

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

Mettre à jour une organisation existante. Nécessite un 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/

Exemple de réponse

{
  "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. Nécessite un rôle d’administrateur. Cette action est irréversible et supprimera toutes les applications, bundles (versions) et ressources associés.

Paramètres de requête

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

Exemple de demande

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

Exemple de réponse

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

Gestion des erreurs

Scénarios d’erreur 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. Nom : utilisez des noms clairs et descriptifs pour les organisations
2. Rôles : attribuez les rôles appropriés aux membres de l’équipe
3. E-mail : utilisez une adresse e-mail de groupe pour management_email afin d’éviter les problèmes liés aux modifications d’adresse e-mail personnelle.
4. Logo : hébergez les logos sur un CDN fiable et utilisez des URL HTTPS