Aplikasi

Apps adalah entitas dasar di Capgo. Setiap app mewakili aplikasi Capacitor yang unik dan dapat Anda kelola serta perbarui melalui platform. Apps API memungkinkan Anda membuat, mengambil, memperbarui, dan menghapus konfigurasi app.

Memahami Aplikasi

App di Capgo mewakili aplikasi Capacitor Anda dan mencakup:

• ID Aplikasi: Identifier unik untuk aplikasi Anda
• Nama: Nama aplikasi yang mudah dibaca
• Ikon: Pengenal visual untuk aplikasi Anda di dashboard
• Konfigurasi: Pengaturan untuk mengontrol cara update dikirim
• Kepemilikan: Informasi organisasi dan akses pengguna
• Statistik penggunaan: Metrik tentang instalasi dan update

Praktik Terbaik

1. Konvensi penamaan: Gunakan nama yang jelas dan mudah dikenali untuk aplikasi Anda
2. Keamanan: Lindungi kunci API dan kredensial akses Anda
3. Organisasi: Kelompokkan aplikasi terkait di bawah organisasi yang sama
4. Monitoring: Pantau statistik dan performa aplikasi secara berkala
5. Backup: Pertahankan backup konfigurasi untuk aplikasi kritis

Endpoint

GET

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

Ambil informasi tentang aplikasi Anda.

Parameter Query

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

Untuk mengambil aplikasi tertentu:

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

Tipe Response

Catatan: last_version merujuk pada bundle (versi) terakhir yang di-upload untuk aplikasi tersebut.

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 Request

# 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 Response

{
  "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 app baru.

Body Request

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

Contoh Request

# 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 di dalam path URL.

Body Request

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

Contoh Request

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 app dan semua resource terkait. App ID ditentukan pada path URL. Gunakan dengan sangat hati-hati karena tindakan ini tidak dapat dibatalkan.

Contoh Request

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

Respons Sukses

{
  "status": "ok"
}

Penanganan error

Semua error menggunakan format error standar yang dijelaskan di Ikhtisar API.

Skenario error umum dan responsnya:

// Missing or invalid API key (HTTP 401)
{
  "error": "invalid_apikey",
  "message": "Invalid apikey",
  "moreInfo": {}
}

// app_id is not a reverse-domain identifier
{
  "error": "invalid_app_id",
  "message": "App ID must be a reverse domain string",
  "moreInfo": { "app_id": "my app" }
}

// The API key has no access to this app (HTTP 401)
{
  "error": "cannot_access_app",
  "message": "You can't access this app",
  "moreInfo": { "app_id": "com.example.app" }
}

// Creating an app in an organization the key cannot write to (HTTP 403)
{
  "error": "cannot_access_organization",
  "message": "You can't access this organization",
  "moreInfo": { "org_id": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }
}

// Retention above the two-year limit on update
{
  "error": "retention_to_big",
  "message": "Retention cannot be bigger than 63113903 (2 years)",
  "moreInfo": { "retention": 99999999 }
}

Kasus Penggunaan Umum

1. Buat App Baru

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

2. Update Konfigurasi App

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

3. Atur Retention Policy

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

4. Get Apps per 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"

Manajemen Resource

1. Optimasi Penyimpanan: Pantau penggunaan storage dan atur kebijakan retensi yang sesuai
2. Organisasi: Kelompokkan aplikasi terkait dalam satu organisasi
3. Kontrol Akses: Kelola anggota tim yang bisa mengubah pengaturan aplikasi
4. Strategi Backup: Backup konfigurasi dan pengaturan aplikasi yang kritikal

Lanjutkan dari Apps

Jika Anda menggunakan Aplikasi untuk merencanakan operasi dashboard dan API, hubungkan dengan Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, Perangkat untuk detail implementasi di Devices, dan Bundle untuk detail implementasi di Bundles.