Organizzazioni

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

Uso comune

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

Punti di accesso

GET

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

Recupera informazioni sull'organizzazione. Se orgId è fornito nei parametri, restituisce un'organizzazione singola. 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/

Creare una nuova organizzazione.

Quando si utilizza una chiave API, la chiave deve avere la permessione globale e una chiave organizzazione-scopata corrente o org.create o org_admin Alternativa: oppure org_super_admin legame. Ciò è richiesto perché l'organizzazione di destinazione non esiste ancora, quindi il controllo RBAC normale non può essere eseguito contro di essa.

Quando la richiesta ha successo, Capgo assegna automaticamente la stessa API chiave sul nuovo organismo. org_super_admin Nota

La chiave __CAPGO_KEEP_0__ non è concessa di default ai nuovi __CAPGO_KEEP_0__ chiavi. Abilita

org.create is not granted to new API keys by default. Enable in forma di chiave __CAPGO_KEEP_0__, o includi quando si crea la chiave attraverso il API. "global_permissions": ["org.create"] when creating the key through the API.

Sottosezione intitolata “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/

Esempio di Risposta

{
  "id": "org_456"
}

Errore di Autorizzazione

Se la chiave API non è presente org.createil 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"
  }
}

CANCELLA

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

Cancella un'organizzazione esistente. Richiede la possibilità di cancellare l'organizzazione bersaglio, di solito 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

• orgId: L'ID dell'organizzazione da cancellare

Scheda di esempio

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

Risposta di esempio

{
  "status": "ok"
}

Gestione degli errori

Scenari di errore comuni e le loro 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 raccomandate

1. Nominativi: Utilizza nomi descrittivi chiari per le organizzazioni
2. Ruoli: Assegna ruoli appropriati ai membri del team
3. Indirizzo e-mailcontext: Pagina/area: Sito web di marketing Capgo. Ruolo: Etichetta UI. Visualizzato in: pagina register.astro. Chiave messaggio `email_label` (Etichetta dell'indirizzo e-mail). | Pagina/area: Pagina prodotto di aggiornamenti in tempo reale. Ruolo: Etichetta UI. Chiave messaggio `live_update_guidance_email_label` (Guida all'aggiornamento in tempo reale - Etichetta dell'indirizzo e-mail).
4. : Utilizza un indirizzo e-mail di gruppo per il campo management_email per evitare problemi con le modifiche all'indirizzo e-mail personaleLogo

: Host i loghi su un CDN affidabile e utilizza URL HTTPS

Sottosezione intitolata “Continua da qui: Organizzazioni” Se stai utilizzando Organizzazioni per pianificare il dashboard e le API operazioni, collega il tuo account con Panoramica API per i dettagli di implementazione in Panoramica API 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 Pacchetti per i dettagli di implementazione in Pacchetti.