Organizations

Le organizzazioni sono le entità di primo livello in Capgo. Ti consentono di raggruppare app, membri del team e risorse sotto un unico ombrello. Ogni organizzazione può avere più membri con ruoli e autorizzazioni diversi.

Casi d’uso comuni

• Creare una nuova organizzazione per la vostra azienda
• Gestione delle impostazioni dell’organizzazione
• Aggiornamento delle informazioni sull’organizzazione
• Recupero dei dettagli dell’organizzazione

Endpoint

OTTIENI

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

Recuperare informazioni sull’organizzazione. Se nei parametri viene fornito orgId, restituisce una singola organizzazione. In caso contrario, restituisce tutte le organizzazioni accessibili.

Parametri della query

• orgId (facoltativo): l’ID dell’organizzazione specifica da recuperare

Tipo di risposta

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
}

Richiesta di esempio

# 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

Esempio di risposta

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

Crea una nuova organizzazione.

Richiedi corpo

interface OrganizationCreate {
  name: string
}

Richiesta di esempio

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

Esempio di risposta

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

METTI

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

Aggiorna un’organizzazione esistente. Richiede il ruolo di amministratore.

Richiedi corpo

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

Richiesta di esempio

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/

Esempio di risposta

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

ELIMINA

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

Elimina un’organizzazione esistente. Richiede il ruolo di amministratore. Questa azione è irreversibile e rimuoverà tutte le app, i bundle (versioni) e le risorse associati.

Parametri della query

• orgId: l’ID dell’organizzazione da eliminare

Richiesta di esempio

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

Esempio di risposta

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

Gestione degli errori

Scenari di errore comuni e relative risposte:

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

Migliori pratiche

1. Denominazione: utilizza nomi chiari e descrittivi per le organizzazioni
2. Ruoli: assegna ruoli appropriati ai membri del team
3. E-mail: utilizza un’e-mail di gruppo per management_email per evitare problemi con le modifiche dell’e-mail personale
4. Logo: ospita i loghi su una CDN affidabile e utilizza URL HTTPS