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 diberikan dalam parameter, maka akan mengembalikan organisasi tunggal. Jika tidak, maka akan mengembalikan semua organisasi yang dapat diakses.

Parameter Kueri

• orgId (opsional): ID organisasi spesifik untuk mengambil

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 "authorization: your-api-key" https://api.capgo.app/organization/

# Get specific organization
curl -H "authorization: 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.

__CAPGO_KEEP_0__

interface OrganizationCreate {
  name: string
}

Contoh Permintaan

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Organization"
  }' \
  https://api.capgo.app/organization/

Contoh Respons

{
  "status": "Organization created",
  "id": "org_456"
}

PUT

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

Perbarui organisasi yang sudah ada. Memerlukan peran admin.

Tubuh Permintaan

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

Contoh Permintaan

curl -X PUT \
  -H "authorization: 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 peran admin. Aksi ini tidak dapat dikembalikan dan akan menghapus semua aplikasi, paket (versi), dan sumber daya terkait.

Parameter Kueri

• orgIdID organisasi yang akan dihapus

Contoh Permintaan

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

Contoh Respons

{
  "status": "Organization deleted",
  "id": "org_123"
}

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. : Tugaskan peran yang tepat kepada anggota timAlamat Email
3. __CAPGO_KEEP_0__Pilih email kelompok untuk management_email untuk menghindari masalah dengan perubahan email pribadi.
4. LogoPilihlah CDN yang dapat diandalkan untuk menyimpan logo dan gunakan URL HTTPS.