Organizations

Organisasi adalah entitas tingkat teratas di Capgo. Mereka memungkinkan Anda mengelompokkan aplikasi, anggota tim, dan sumber daya di bawah satu payung. Setiap organisasi dapat memiliki banyak anggota dengan peran dan izin berbeda.

Kasus Penggunaan Umum

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

Titik akhir

DAPATKAN

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

Ambil informasi organisasi. Jika orgId disediakan dalam parameter, mengembalikan satu organisasi. Jika tidak, kembalikan semua organisasi yang dapat diakses.

Parameter Kueri

• orgId (opsional): ID organisasi tertentu yang akan diambil

Jenis Respons

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

POSTINGAN

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

Buat organisasi baru.

Isi Permintaan

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 Respon

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

MASUKKAN

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

Perbarui organisasi yang ada. Membutuhkan peran admin.

Isi 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 Respon

{
  "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 ada. Membutuhkan peran admin. Tindakan ini tidak dapat diubah dan akan menghapus semua aplikasi, paket (versi), dan sumber daya terkait.

Parameter Kueri

• orgId: ID organisasi yang akan dihapus

Contoh Permintaan

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

Contoh Respon

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

Penanganan Kesalahan

Skenario kesalahan umum dan tanggapannya:

// 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: Tetapkan peran yang sesuai kepada anggota tim
3. Email: Gunakan email grup untuk email_manajemen untuk menghindari masalah dengan perubahan email pribadi
4. Logo: Menghosting logo di CDN yang andal dan menggunakan URL HTTPS