Aplikasi

Aplikasi adalah entitas dasar dalam Capgo. Setiap aplikasi mewakili aplikasi unik Capacitor yang dapat Anda kelola dan update melalui platform. Fitur Apps API memungkinkan Anda untuk membuat, mengambil, memperbarui, dan menghapus konfigurasi aplikasi.

Mengerti Aplikasi

Aplikasi dalam Capgo mewakili aplikasi Capacitor Anda dan termasuk:

• ID Aplikasi: Identifikasi unik untuk aplikasi Anda
• Nama: Nama yang dapat dibaca manusia untuk aplikasi Anda
• Ikon: Identifikasi visual untuk aplikasi Anda di dashboard
• Konfigurasi: Pengaturan yang mengontrol bagaimana pembaruan disampaikan
• Pemilikan: Informasi akses organisasi dan pengguna
• Statistik Penggunaan: Metrik tentang instalasi dan pembaruan

Praktik Terbaik

1. Konvensi Nama: Gunakan nama yang jelas dan dapat diidentifikasi untuk aplikasi Anda
2. Keamanan: Lindungi kunci API dan kredential akses Anda
3. Organisasi: Grupkan aplikasi terkait di bawah organisasi yang sama
4. Pengawasan: Periksa secara teratur statistik dan kinerja aplikasi
5. Cadangan: Jaga cadangan konfigurasi untuk aplikasi kritis

Endpoint

GET

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

Ambil informasi tentang aplikasi Anda.

Parameter Pemintaan

• page: Opsional. Nomor halaman untuk pengaturan halaman
• limit: Opsional. Jumlah hasil per halaman (default: 50)
• org_id: Opsional. Filter aplikasi berdasarkan ID organisasi. Jika tidak disediakan, akan mengembalikan aplikasi dari semua organisasi yang diakses pengguna

Untuk mendapatkan aplikasi tertentu:

• Gunakan ID aplikasi dalam URL path: https://api.capgo.app/app/:app_id

Jenis Respon

Perlu diingat: last_version merujuk pada bundle terakhir (versi) yang diunggah untuk aplikasi.

interface App {
  app_id: string
  created_at: string | null
  default_upload_channel: string
  icon_url: string
  id: string | null
  last_version: string | null // last bundle (version) name
  name: string | null
  owner_org: string
  retention: number
  transfer_history: Json[] | null
  updated_at: string | null
  user_id: string | null
}

Contoh Permintaan

# Get all apps
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/"

# Get apps from a specific organization
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

# Get specific app
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/com.demo.app"

Contoh Respons

{
  "data": [
    {
      "app_id": "com.demo.app",
      "created_at": "2024-01-01T00:00:00Z",
      "default_upload_channel": "dev",
      "icon_url": "https://example.com/icon.png",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "last_version": "1.0.0",
      "name": "Demo App",
      "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
      "retention": 2592000,
      "transfer_history": null,
      "updated_at": "2024-01-01T00:00:00Z",
      "user_id": "6aa76066-55ef-4238-ade6-0b32334a4097"
    }
  ]
}

POST

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

Buat aplikasi baru.

Tubuh Permintaan

interface CreateApp {
  app_id: string
  name: string
  icon?: string
  owner_org: string
}

Contoh Permintaan

# Create new app
curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New App",
    "app_id": "com.demo.myapp", // this id is unique in Capgo This cannot be reused by any account.
    "icon": "https://example.com/icon.png",
    "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
  }' \
  https://api.capgo.app/app/

Respons Berhasil

{
  "app_id": "My New App",
  "created_at": "2024-01-01T00:00:00Z",
  "default_upload_channel": "dev",
  "icon_url": "https://example.com/icon.png",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My New App",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
  "retention": 2592000,
  "updated_at": "2024-01-01T00:00:00Z"
}

PUT

https://api.capgo.app/app/:app_id

Perbarui aplikasi yang sudah ada. ID aplikasi ditentukan dalam jalur URL.

Tubuh Permintaan

interface UpdateApp {
  name?: string
  icon?: string
  retention?: number
}

Contoh Permintaan

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated App Name",
    "icon": "https://example.com/updated-icon.png",
    "retention": 45
  }' \
  https://api.capgo.app/app/com.demo.app

Respons Sukses

{
  "app_id": "com.demo.app",
  "created_at": "2024-01-01T00:00:00Z",
  "default_upload_channel": "dev",
  "icon_url": "https://example.com/updated-icon.png",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Updated App Name",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
  "retention": 45,
  "updated_at": "2024-01-01T00:00:00Z"
}

Hapus

https://api.capgo.app/app/:app_id

Hapus aplikasi dan semua sumber daya terkait. ID aplikasi ditentukan dalam jalur URL. Gunakan dengan hati-hati karena aksi ini tidak dapat dibatalkan.

Contoh Permintaan

curl -X DELETE \
  -H "authorization: your-api-key" \
  https://api.capgo.app/app/com.demo.app

Respons Sukses

{
  "status": "ok"
}

Pengelolaan Kesalahan

Skenario kesalahan umum dan responsnya:

// App not found
{
  "error": "App not found",
  "status": "KO"
}

// Duplicate custom ID
{
  "error": "Custom ID already in use",
  "status": "KO"
}

// Invalid parameters
{
  "error": "Invalid app configuration",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage app",
  "status": "KO"
}

// Organization access denied
{
  "status": "You do not have access to this organization"
}

Penggunaan Umum

1. Buat Aplikasi Baru

// Set up a new app
{
  "name": "Production App",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
}

2. Perbarui Konfigurasi Aplikasi

// Change app name and icon
{
  "name": "Rebranded App Name",
  "icon": "https://example.com/new-icon.png"
}

3. Atur Kebijakan Retensi

// Configure automatic bundle cleanup
{
  "retention": 30 // Keep bundles for 30 days
}

4. Dapatkan Aplikasi oleh Organisasi

# List all apps in a specific organization
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

Pengelolaan Sumber Daya

1. Optimasi PenyimpananPantau penggunaan penyimpanan dan atur kebijakan penyimpanan yang sesuai
2. OrganisasiPantau Penggunaan Penyimpanan dan Atur Kebijakan Penyimpanan yang Sesuai
3. Kelompok AplikasiPantau Penggunaan Penyimpanan dan Atur Kebijakan Penyimpanan yang Sesuai
4. Pengendalian AksesKelola Anggota Tim yang Dapat Mengubah Pengaturan Aplikasi