기기

Devices는 Capgo에 업데이트 메타데이터를 보고하는 개별 앱 설치입니다. 이 API을 사용하여 해당 메타데이터를 가져오거나, 기기별 프라이빗 채널 오버라이드를 설정 및 제거할 수 있습니다.

90일 정책 2개

디바이스 인벤토리: 디바이스 레코드는 다음 기간 동안 보관됩니다: 90일 마지막 디바이스 활동 기준. 디바이스가 표시되는 데 업데이트를 설치할 필요는 없습니다: updater와 stats 체크인이 메타데이터를 갱신할 수 있습니다.

채널 오버라이드: POST 오버라이드는 다음 시점에 제거됩니다: 마지막 오버라이드 쓰기 후 90일, 디바이스가 계속 체크인하더라도 제거됩니다. 체크인해도 해당 기한은 초기화되지 않습니다. 해당 정리 작업을 피하려면 defaultChannel Capacitor config에 설정하거나(재설치 후에도 유지), 또는 setChannel() 앱에서 호출하세요. 이 @capgo/capacitor-updater 메서드 setChannel() 및 unsetChannel() Android 및 iOS에서만 지원됩니다. plugin 5.34.0 / 6.34.0 / 7.34.0 / 8.0.0 이상 버전에서는, setChannel() 로컬에 저장되며 이 cleanup 작업으로 삭제되지 않습니다. updater 8.51.0 이상 버전의 Android 및 iOS에서는, persistDefaultChannelOnReinstall 기본값은 true따라서 운영 체제가 앱 데이터를 복원하고 옵션이 계속 활성화되어 있는 경우에만 로컬 할당이 재설치 후에도 유지됩니다. 이전 updater로 재설치하거나, 앱 데이터가 복원되지 않은 상태에서 클린 재설치를 수행하거나, 재설치 시 persistDefaultChannelOnReinstall: false 를 설정하면 로컬 할당이 삭제될 수 있습니다. 로컬 선택을 명시적으로 삭제하려면 unsetChannel() 를 사용하세요. 이는 console/API overrides를 삭제하지 않습니다. 위에 나온 local-channel 버전보다 오래된 plugin은 재설치 후에도 유지되는 backend override를 기록하며, 이 cleanup 작업으로 삭제됩니다. 자세한 내용은 Console 및 API override는 90일 후 만료됩니다.

디바이스 메타데이터

각 레코드에는 디바이스 ID, 플랫폼, updater 및 OS 버전, Native Build, 설치된 bundle, 프로덕션 및 에뮬레이터 상태, custom ID, channel override가 포함될 수 있습니다.

사용 가능한 경우, country_code 는 해당 디바이스에 대해 Cloudflare에서 처리된 요청으로부터 수신한 최신 유효 2자리 ISO 3166-1 국가 code입니다. 이는 GPS 또는 앱에서 제공한 위치 값이 아닙니다. 다음과 같을 수 있습니다. null 사용할 수 없을 때, 이 필드가 필요하면 단일 디바이스 조회를 사용하세요.

엔드포인트

POST

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

디바이스별 오버라이드를 다음으로 설정: 비공개 channel. 디바이스에 사용할 bundle을 선택하려면 해당 bundle을 channel에 할당하세요. 디바이스별 직접 bundle 오버라이드는 지원되지 않습니다. 오버라이드는 다시 POST하지 않으면 마지막 쓰기 후 90일이 지나면 만료됩니다.

요청 본문

interface DeviceChannelOverride {
  app_id: string; // reverse-domain app ID, for example com.example.app
  device_id: string;
  channel: string; // existing non-public channel name
}

요청 예시

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "device_id": "device_456",
    "channel": "beta"
  }' \
  https://api.capgo.app/device/

공개 채널은 디바이스 오버라이드로 사용할 수 없습니다.

성공 응답

{
  "status": "ok"
}

GET

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

디바이스 메타데이터를 가져옵니다. 다음을 생략하면 결과가 커서 페이지네이션됩니다. device_id.

쿼리 매개변수

• app_id: 필수 역도메인 앱 ID, 예: com.example.app.
• device_id: 선택적 디바이스 ID. 지정 시 응답이 페이지네이션된 목록이 아닌 단일 디바이스가 됩니다.
• customIdMode: 선택적 불리언 값. true 으로 설정하면 비어 있지 않은 custom_id.
• cursor: 이전 목록 응답에서 가져온 선택적 커서.
• limit: 페이지당 디바이스 수(선택적).

요청 예시

# Get the first page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app"

# Get one device, including its request-derived country when available
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&device_id=device_456"

# Get only devices with a custom ID
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&customIdMode=true"

# Get the next page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&cursor=2024-01-01T00:00:00Z%7Cdevice_456"

응답 유형

interface DeviceListResponse {
  data: Device[];
  nextCursor?: string;
  hasMore: boolean;
}

interface Device {
  updated_at: string;
  device_id: string;
  custom_id: string;
  version?: number;
  version_name: string | null;
  channel?: string;
  app_id: string;
  platform: "ios" | "android" | "electron";
  plugin_version: string;
  os_version: string;
  version_build: string;
  is_prod: boolean;
  is_emulator: boolean;
  key_id: string | null;
  install_source: string | null;
  country_code: string | null;
}

country_code Capgo에 유효한 Cloudflare 기반 국가 code가 저장된 경우, 디바이스별 조회를 통해 값이 설정됩니다. 유효한 국가 정보가 없는 요청은 마지막 유효 값을 지우지 않으며, 목록 응답은 다음 값을 반환할 수 있습니다. null 이 필드에 대해.

응답 예시 (목록)

{
  "data": [
    {
      "device_id": "device_456",
      "custom_id": "test-device-1",
      "version": 1,
      "version_name": "1.0.0",
      "app_id": "com.example.app",
      "platform": "ios",
      "plugin_version": "5.0.0",
      "os_version": "17.0",
      "version_build": "1",
      "is_prod": true,
      "is_emulator": false,
      "key_id": null,
      "install_source": null,
      "country_code": null,
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "2024-01-01T00:00:00Z|device_456",
  "hasMore": true
}

응답 예시 (단일 디바이스)

{
  "device_id": "device_456",
  "custom_id": "test-device-1",
  "version": 1,
  "version_name": "1.0.0",
  "app_id": "com.example.app",
  "platform": "ios",
  "plugin_version": "5.0.0",
  "os_version": "17.0",
  "version_build": "1",
  "is_prod": true,
  "is_emulator": false,
  "key_id": "MIIB",
  "install_source": null,
  "country_code": "FR",
  "updated_at": "2024-01-01T00:00:00Z",
  "channel": "beta"
}

DELETE

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

기기의 채널 오버라이드를 제거합니다. 기기는 다시 일반적인 채널 선택을 사용하며, 이 엔드포인트는 메타데이터 기록을 삭제하지 않습니다.

Request body 또는 쿼리 파라미터

interface DeviceOverrideRemoval {
  app_id: string;
  device_id: string;
}

요청 예시

curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "device_id": "device_456"
  }' \
  https://api.capgo.app/device/

성공 응답

{
  "status": "ok"
}

에러

에러는 HTTP 에러 상태 코드와 JSON 바디를 사용합니다. error 및 message 다음과 같은 필드를 포함합니다. 일반적인 에러 코드는 다음과 같습니다:

• invalid_app_id 할 때 app_id 역도메인 식별자가 아닙니다.
• device_not_found 알 수 없는 디바이스 조회 시 발생합니다.
• channel_not_found 요청한 채널이 존재하지 않을 때 발생합니다.
• public_channel_override 디바이스를 공개 채널로 오버라이드하려고 할 때 발생합니다.
• invalid_version_id 직접 번들 오버라이드를 시도할 때 발생합니다. 대신 채널을 사용하세요.
• cannot_access_app 또는 cannot_access_channel API 키에 필요한 권한이 없는 경우.

일반적인 사용 사례

1. 테스트 기기를 프라이빗 베타 채널로 이동

   {
     "app_id": "com.example.app",
     "device_id": "device_456",
     "channel": "beta"
   }

2. 기기 채널 선택을 기본값으로 초기화

   트레이드오프를 평가하려면 DELETE 앱 및 기기 ID가 포함된 엔드포인트.

Devices에서 계속하기

사용 중이라면 기기 채널 라우팅과 단계적 배포를 계획하려면, 다음을 연결하세요: 채널 Channels의 구현 세부 사항은 다음을 참고하세요: 채널 Channels의 구현 세부 사항은 다음을 참고하세요: 채널 Channels의 구현 세부 사항은 다음을 참고하세요: Beta Testing 솔루션 Beta Testing 솔루션의 제품 워크플로우를 위한, 그리고 버전 타겟팅 솔루션 Version Targeting Solution의 제품 워크플로우용.