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 izin yang berbeda.

Penggunaan Umum

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

Endpoint

GET

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

Pengambilan informasi organisasi. Jika orgId parameter yang diberikan, maka akan mengembalikan organisasi tunggal. Jika tidak, maka akan mengembalikan semua organisasi yang dapat diakses.

Parameter Pencarian

• orgId (opsional): ID organisasi spesifik untuk diambil

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
}

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 organisasi yang berlaku saat ini atau org.create atau org_admin Ketika menggunakan kunci __CAPGO_KEEP_0__, kunci harus memiliki izin global dan organisasi yang berlaku saat ini atau org_super_admin terikat. Ini diperlukan karena organisasi target belum ada, sehingga RBAC yang biasanya terkait dengan organisasi tidak dapat dicek terhadapnya.

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

Catatan

org.create is not granted to new API keys by default. Enable Memungkinkan pembuatan organisasi in the API key form, or include "global_permissions": ["org.create"] when creating the key through the 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, kunci API mengembalikan:

{
  "error": "permission_denied"
}

PUT

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

Perbarui organisasi yang sudah ada. Memerlukan peran admin pada 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 org_super_admin peran. Aksi ini tidak dapat dibatalkan dan akan menghapus semua aplikasi terkait, paket (versi), dan sumber daya.

Peran global tidak memungkinkan menghapus organisasi. org.create Parameter Kueri

Bab berjudul “Parameter Kueri”

• orgIdContoh Permintaan

Bab berjudul “Contoh Permintaan”

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

Contoh Respon

{
  "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 organisasi yang jelas dan deskriptif
2. Peran: Tugaskan peran yang sesuai kepada anggota tim
3. Alamat Emailcontext: Page/area: Capgo website pemasaran. Peran: Label UI. Dilihat di: halaman register.astro. Kunci pesan `email_label` (Label Alamat Email). | Page/area: Halaman produk live update. Peran: Label UI. Kunci pesan `live_update_guidance_email_label` (Label Alamat Email Panduan Live Update).
4. : Gunakan alamat email kelompok untuk menghindari masalah dengan perubahan alamat email pribadiLogo

: Tampilkan logo di CDN yang dapat diandalkan dan gunakan URL HTTPS

Judul bagian ‘Teruskan dari Organisasi’ : Jika Anda menggunakan Organisasi untuk merencanakan dashboard dan API operasi, hubungkan dengan Ringkasan API untuk detail implementasi di Ringkasan API 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.