Organisations

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

Utilisations courantes

• Création d'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 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

Section intitulée « Paramètres de requête »

• orgId Type de réponse

Section intitulée « 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
}

Section intitulée « Paramètres de requête »

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

# Get specific organization
curl -H "x-api-key: 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.

Lorsque vous utilisez une clé API, la clé doit avoir la permission globale et une organisation-scopée actuelle org.create ou org_admin HTML : ou (contexte : page de comparaison de alternatives de mise à jour en direct de Capacitor. Rôle : Paragraphe marketing ou juridique long. Voir : page alternatives.astro. Conserver les termes de produit et de marque de Capgo ainsi que les termes de développeur exactement. Clé de message `alternatives_cta_questions` (Questions de CTA alternatives). | HTML : ou (contexte : page de comparaison / migration de Appflow. Rôle : Paragraphe marketing ou juridique long. Voir : page ionic-appflow.astro. Conserver les termes de produit et de marque de Capgo ainsi que les termes de développeur exactement. Clé de message `appflow_cta_questions` (Questions de CTA Appflow). | HTML : ou (contexte : page de comparaison de Capawesome. Rôle : Paragraphe marketing ou juridique long. Voir : page capwesome.astro. Conserver les termes de produit et de marque de Capgo ainsi que les termes de développeur exactement. Clé de message `capwesome_cta_questions` (Questions de CTA Capwesome). | HTML : ou (contexte : page de services de consulting. Rôle : Sous-titre ou tagline de section. Voir : page consulting.astro. Conserver les termes de produit et de marque de Capgo ainsi que les termes de développeur exactement. Clé de message `consulting_faq_subtitle` (Sous-titre FAQ de consulting). | HTML : ou (contexte : page de comparaison / migration de Appflow. Rôle : Étiquette de navigation ou élément de navigation court. Voir : page ionic-appflow.astro, page ionic-enterprise-plugins.astro, page solutions/ionic-enterprise-plugins.astro. Clé de message `appflow_plugins_or` (Appflow Plugins ou). org_super_admin liaison. Cela est obligatoire car l'organisation cible n'existe pas encore, donc la RBAC normal scoping par organisation ne peut pas être vérifiée contre elle.

Lorsque la demande réussit, Capgo attribue automatiquement la même clé API sur l'organisation nouvelle. org_super_admin sur l'organisation nouvelle.

Remarque

org.create la clé API n'est pas attribuée par défaut aux nouvelles clés. Activez Autoriser la création d'organisations dans la forme de clé API, ou incluez "global_permissions": ["org.create"] lors de la création de la clé via l’API.

Corps de la demande

interface OrganizationCreate {
  name: string
  email?: string
  estimatedMau?: number
  website?: string
}

Exemple de requête

curl -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Organization",
    "email": "admin@example.com",
    "website": "https://example.com"
  }' \
  https://api.capgo.app/organization/

Exemple de réponse

{
  "id": "org_456"
}

Erreur de permission

Si la clé API n'a pas de valeur, la clé API retourne : org.create, the API returns:

{
  "error": "permission_denied"
}

MAJ

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

Mettez à jour une organisation existante. Exige le rôle d'administrateur sur l'organisation cible.

Corps de la demande

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

Exemple de demande

curl -X PUT \
  -H "x-api-key: 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. Exige la permission de suppression sur l'organisation cible, généralement à travers le org_super_admin rôle. Cette action est irréversible et supprimera tous les applications associées, les lots (versions) et les ressources.

Le org.create permis global ne permet pas de supprimer les organisations.

Paramètres de requête

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

Exemple de requête

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

Réponse d'exemple

{
  "status": "ok"
}

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ôlesAssignez des rôles appropriés aux membres de l'équipe
3. Adresse e-mailLogo
4. Continuez de la section OrganisationsSi vous utilisez la section Organisations

Organisations

connectez-l’avec Roles to plan dashboard and API operations, connect it with API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour le détail d'implémentation dans Introduction, API Clés pour le détail d'implémentation dans API Clés, Appareils pour le détail d'implémentation dans Appareils, et Paquets pour le détail d'implémentation dans Paquets.