Organisasi

Organisasi adalah entitas tingkat atas di Capgo. Mereka memungkinkan Anda untuk mengelompokkan aplikasi, anggota tim, dan sumber daya di bawah payung tunggal. Setiap organisasi dapat memiliki anggota yang berbeda dengan peran dan hak akses yang berbeda.

Penggunaan Umum

• Membuat organisasi baru untuk perusahaan Anda
• Mengelola pengaturan organisasi
• Mengupdate informasi organisasi
• Mengambil detail organisasi

Endpoint

GET

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

Mengambil informasi organisasi. Jika orgId tersedia dalam parameter, maka mengembalikan organisasi tunggal. Selain itu, mengembalikan semua organisasi yang dapat diakses.

Parameter Pencarian

• orgId (opsional): ID organisasi spesifik untuk diambil

Tipe Respon

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
}

Contoh Permintaan

# 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

Contoh Respon

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

Buat organisasi baru.

Ketika menggunakan kunci API, kunci tersebut harus memiliki izin global dan organisasi terkait saat ini, atau, kunci yang terkait. org.create Hal ini diperlukan karena organisasi target belum ada, sehingga RBAC normal tidak dapat dicek terhadapnya. org_admin Ketika permintaan berhasil, __CAPGO_KEEP_0__ secara otomatis mengasosiasikan kunci __CAPGO_KEEP_1__ yang sama dengan organisasi baru. org_super_admin Catatan

When the request succeeds, Capgo automatically assigns the same API key as org_super_admin POST

Buat organisasi baru.

org.create Ketika menggunakan kunci API, kunci tersebut harus memiliki izin global dan organisasi terkait saat ini, atau, kunci yang terkait. Mengizinkan pembuatan organisasi dalam bentuk kunci API, atau termasuk "global_permissions": ["org.create"] ketika membuat kunci melalui API.

Badan Permintaan

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

Contoh Permintaan

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/

Contoh Respons

{
  "id": "org_456"
}

Error Ijin

Jika kunci API tidak memiliki org.create maka API mengembalikan:

{
  "error": "permission_denied"
}

PUT

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

Perbarui organisasi yang sudah ada. Memerlukan peran admin di organisasi target.

Badan Permintaan

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

Contoh Permintaan

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/

Contoh Respons

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

HAPUS

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

Hapus organisasi yang sudah ada. Memerlukan izin hapus pada organisasi target, biasanya melalui peran. Aksi ini tidak dapat dikembalikan dan akan menghapus semua aplikasi terkait, paket (versi), dan sumber daya. org_super_admin __CAPGO_KEEP_0__

__CAPGO_KEEP_0__ org.create Izin global tidak memungkinkan menghapus organisasi.

Parameter Pencarian

• orgId: ID organisasi yang akan dihapus

Contoh Permintaan

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

Contoh Respons

{
  "status": "ok"
}

Pengelolaan Kesalahan

Skenario kesalahan umum dan responsnya:

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

Praktik Terbaik

1. Judul: Praktik TerbaikPemberian Nama
2. : Gunakan nama yang jelas dan deskriptif untuk organisasiPemberian Peran
3. : Tugaskan peran yang tepat kepada anggota timEmail
4. : Gunakan email kelompok untuk management_email untuk menghindari masalah dengan perubahan email pribadi: Tampilkan logo di CDN yang dapat diandalkan dan gunakan URL HTTPS

Teruskan dari Organisasi

Jika Anda menggunakan Organisasi untuk merencanakan dashboard dan operasi API, hubungkannya dengan API Ringkasan untuk detail implementasi di API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di Kunci API Perangkat untuk detail implementasi di Perangkat, dan Paket untuk detail implementasi di Paket.