Organizzazioni

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

Uso comune

• Creazione di una nuova organizzazione per la tua azienda
• Gestione delle impostazioni dell'organizzazione
• Aggiornamento delle informazioni dell'organizzazione
• Recupero dei dettagli dell'organizzazione

Punti finale

GET

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

Recupera informazioni sull'organizzazione. Se orgId è fornito nei parametri, restituisce un'unica organizzazione. Altrimenti, restituisce tutte le organizzazioni accessibili.

Parametri di 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
}

Esempio di richiesta

# 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

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.

Quando si utilizza una chiave API, la chiave deve avere la org.create permesso globale e un organizzazione-scoped org_admin o org_super_admin legame corrente. Questo è richiesto perché l'organizzazione di destinazione non esiste ancora, quindi la normale RBAC dell'organizzazione non può essere verificata contro di essa.

Quando la richiesta ha successo, Capgo assegna automaticamente la stessa chiave API org_super_admin On l'organizzazione nuova.

Nota

org.create Non è concesso per le nuove chiavi API di default. Abilita Consenti la creazione di organizzazioni nel formato della chiave API, o includi "global_permissions": ["org.create"] quando si crea la chiave attraverso il API.

Corpo della richiesta

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

Esempio di richiesta

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/

Risposta di esempio

{
  "id": "org_456"
}

Errore di permesso

Se la chiave API non esiste org.createla API restituisce:

{
  "error": "permission_denied"
}

PUT

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

Aggiorna un'organizzazione esistente. Richiede il ruolo di amministratore sull'organizzazione di destinazione.

Corpo della richiesta

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

Esempio di richiesta

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/

Esempio di risposta

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

DELETE

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

Cancella un'organizzazione esistente. Richiede la possibilità di cancellare l'organizzazione bersaglio, tipicamente attraverso il org_super_admin ruolo. Questa azione è irreversibile e rimuoverà tutti gli app associati, bundle (versioni) e risorse.

La org.create permesssione globale non consente di cancellare le organizzazioni.

Parametri di query

• orgIdID dell'organizzazione da cancellare

Esempio di richiesta

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

Esempio di Risposta

{
  "status": "ok"
}

Gestione degli Errori

Scenari di errori 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"
}

Pratiche Migliori

1. NominativiUsa nomi descrittivi e chiari per le organizzazioni
2. RuoliAssegna ruoli appropriati ai membri del team
3. Posta elettronicaAssegna un indirizzo di posta elettronica di gruppo a management_email per evitare problemi con le modifiche all'indirizzo di posta elettronica personale
4. LogoHosta i loghi su un CDN affidabile e utilizza URL HTTPS

Continua da Organizzazioni

Se stai utilizzando Organizzazioni per pianificare il dashboard e le operazioni di API , connettile con API Overview per i dettagli di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, Dispositivi per i dettagli di implementazione in Dispositivi, e Bundle per i dettagli di implementazione in Bundle.