Organisasi

Organisasi adalah entitas tingkat atas dalam 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
• Menangani pengaturan organisasi
• Mengupdate informasi organisasi
• Mengambil detail organisasi

Endpoint

PENJUMLAHAN

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

Mengambil informasi organisasi. Jika __CAPGO_KEEP_0__ disediakan dalam parameter, maka akan mengembalikan organisasi tunggal. Jika tidak, maka akan mengembalikan semua organisasi yang dapat diakses. orgId Parameter Pencarian

Bagian berjudul “Parameter Pencarian”

• orgId Jenis Respon

Bagian berjudul “Jenis 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
}

Bagian berjudul “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 Respons

{
  "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 harus memiliki izin global dan izin organisasi saat ini. org.create atau org_admin kunci yang terkait. Hal ini diperlukan karena organisasi target belum ada, sehingga RBAC normal tidak dapat dicek terhadapnya. org_super_admin Ketika permintaan berhasil, __CAPGO_KEEP_0__ secara otomatis mengasosiasikan kunci __CAPGO_KEEP_1__ yang sama

When the request succeeds, Capgo automatically assigns the same API key as org_super_admin pada organisasi baru.

Peringatan

org.create tidak diberikan secara default kepada kunci API. Aktifkan Izinkan membuat 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 pada organisasi target.

Tubuh 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 org_super_admin peran. Aksi ini tidak dapat dibatalkan dan akan menghapus semua aplikasi, paket (versi), dan sumber daya terkait.

Izin org.create izin global tidak memungkinkan menghapus organisasi.

Parameter Kueri

• 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. Penamaan: Gunakan nama yang jelas dan deskriptif untuk organisasi
2. Pengaturan PeranTentukan peran yang tepat bagi anggota tim
3. EmailGunakan email kelompok untuk management_email untuk menghindari masalah dengan perubahan email pribadi
4. LogoTampilkan logo di CDN yang dapat diandalkan dan gunakan HTTPS URLs

Lanjutkan dari Organisasi

Organisasi untuk merencanakan dashboard dan __CAPGO_KEEP_0__ operasional, hubungkan dengan API Ringkasan untuk detail implementasi di API Ringkasan, for the implementation detail in API Overview, Pengenalan untuk detail implementasi di Pengenalan, API Kunci untuk detail implementasi di API Kunci, Perangkat untuk detail implementasi di Perangkat, dan Bundel untuk detail implementasi di Bundel.