Organisationen

Organisationen sind die obersten Entitäten in Capgo. Sie ermöglichen es Ihnen, Apps, Teammitglieder und Ressourcen unter einer einzigen Dachmarke zu gruppieren. Jede Organisation kann mehrere Mitglieder mit unterschiedlichen Rollen und Berechtigungen haben.

Häufige Verwendungsfälle

• Eine neue Organisation für Ihr Unternehmen erstellen
• Organisations-Einstellungen verwalten
• Organisationsinformationen aktualisieren
• Organisationsdetails abrufen

Endpunkte

GET

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

Ruft Organisationeninformationen ab. Wenn ein orgId wenn in den Parametern angegeben ist, wird eine einzelne Organisation zurückgegeben. Ansonsten werden alle zugänglichen Organisationen zurückgegeben.

Abfrageparameter

• orgId (optional): Die ID der spezifischen Organisation, um die zu erhalten

Antworttyp

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
}

Beispielanfrage

# 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

Beispielantwort

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

Eine neue Organisation erstellen.

Anforderungskörper

interface OrganizationCreate {
  name: string
}

Beispielanfrage

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

Beispielergebnis

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

PUT

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

Ein bestehendes Unternehmen aktualisieren. Erfordert die Rolle des Administrators.

Anforderungskörper

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

Beispielanfrage

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/

Beispielantwort

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

LÖSCHEN

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

Eine bestehende Organisation löschen. Erfordert die Rolle des Administrators. Diese Aktion ist unwiderruflich und entfernt alle damit verbundenen Apps, Pakete (Versionen) und Ressourcen.

Abfrageparameter

• orgIdDie ID der Organisation, die gelöscht werden soll

Beispielanfrage

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

Beispielantwort

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

Fehlerbehandlung

Häufige Fehlerfälle und ihre Antworten:

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

Gute Praktiken

1. Benennung: Verwenden Sie klare, beschreibende Namen für Organisationen
2. : Zuordnen Sie geeignete Rollen zu TeammitgliedernAbschnitt mit dem Titel „Namensgebung”
3. E-Mail: Verwenden Sie eine Gruppen-E-Mail für management_email, um Probleme mit Änderungen an persönlichen E-Mails zu vermeiden
4. Logo: Hosten Sie Logos auf einem zuverlässigen CDN und verwenden Sie HTTPS-URLs

Weitermachen von Organisationen

Wenn Sie "Organizations" verwenden Organisationen um das Dashboard und die API-Funktionen zu planen, verbinden Sie sie mit API-Übersicht für die Implementierungsdetails in der API-Übersicht, Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel Geräte für die Implementierungsdetails in Geräte Bundles für die Implementierungsdetails in Bundles