Aplikasi

Salin prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

Aplikasi adalah entitas dasar di 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.

Pengertian Aplikasi

Aplikasi di Capgo mewakili aplikasi Capacitor Anda dan termasuk:

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

Praktik Terbaik

Konvensi NamaGunakan nama aplikasi yang jelas dan dapat dikenali
Keamanan: Perlindungan kunci API Anda dan kredit akses
Organisasi: Kelompokkan aplikasi terkait di bawah organisasi yang sama
Pantauan: Periksa secara teratur statistik aplikasi dan kinerja
Backup: Tahan konfigurasi backup untuk aplikasi kritis

Endpoint

GET

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

Pengambilan informasi tentang aplikasi Anda.

Parameter Pencarian

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 dimiliki pengguna

Untuk mendapatkan aplikasi tertentu:

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

Jenis Respon

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

interface App {
  app_id: string
  block_provider_infra_requests: boolean
  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": [
    {
      "block_provider_infra_requests": true,
      "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.

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

{
  "block_provider_infra_requests": true,
  "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.

Isi Badan Permintaan

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

Contoh Permintaan

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "block_provider_infra_requests": true,
    "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",
  "block_provider_infra_requests": true,
  "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

Buat Aplikasi Baru

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

Perbarui Konfigurasi Aplikasi

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

Atur Kebijakan Retensi

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

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

Optimasi Penyimpanan: Pantau penggunaan penyimpanan dan atur kebijakan penyimpanan yang tepat
Organisasi: Kelompokkan aplikasi terkait di bawah organisasi tunggal
Pengendalian Akses: Kelola anggota tim mana yang dapat mengubah pengaturan aplikasi
Strategi Cadangan: Cadangkan konfigurasi aplikasi kritis dan pengaturan

Teruskan dari Aplikasi

Jika Anda menggunakan Aplikasi untuk merencanakan dashboard dan API operasi, hubungkannya dengan API Ringkasan untuk detail implementasi di API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, Perangkat untuk detail implementasi di Devices, dan Bundles untuk detail implementasi di Paket.