Dispositivos

Los dispositivos son instalaciones de aplicaciones individuales que informan metadatos de actualizador a Capgo. Utiliza este API para recuperar esos metadatos o establecer y eliminar un override de canal privado específico del dispositivo.

Retención de datos

Los datos del dispositivo se retienen por 90 días desde la última actividad del dispositivo. Un dispositivo no necesita instalar una actualización para aparecer: las actualizaciones y los controles de estadísticas pueden actualizar sus metadatos.

Metadatos del dispositivo

Cada registro puede incluir el ID del dispositivo, la plataforma, las versiones del actualizador y del sistema operativo, la construcción nativa, el paquete instalado, el estado de producción y de emulador, el ID personalizado y la sobrescritura de canal.

Cuando esté disponible, country_code is the latest valid two-letter ISO 3166-1 country code received from a Cloudflare-handled request for the device. It is not GPS or a location value supplied by your app. It can be null cuando no esté disponible; utilice una búsqueda de un solo dispositivo cuando necesites este campo.

Puntos finales

POST

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

Establecer un override específico para dispositivo a un canal privado . Para elegir un paquete para un dispositivo, asigna ese paquete al canal; no se admiten overrides de paquetes directos por dispositivo.

Cuerpo de solicitud

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

Solicitud de ejemplo

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/

No se pueden utilizar canales públicos como overrides de dispositivo.

Respuesta de éxito

{
  "status": "ok"
}

GET

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

Recuperar metadatos del dispositivo. Los resultados están paginados con cursor cuando omites device_id.

Parámetros de consulta

• app_idID de aplicación de dominio inverso obligatorio, como com.example.app.
• device_idID de dispositivo opcional. Cuando está presente, la respuesta es un solo dispositivo en lugar de una lista paginada.
• customIdModeOpcional booleano. Establezca a true para devolver solo dispositivos con un custom_id.
• cursorcursor opcional desde la respuesta de lista anterior.
• limit: Número de dispositivos por página (opcional).

Ejemplos de solicitudes

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

Tipos de respuesta

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 se rellena mediante una búsqueda específica del dispositivo cuando Capgo ha almacenado un país válido derivado de Cloudflare-code. Las solicitudes sin un país válido no eliminan el último valor válido; las respuestas de lista pueden devolver null para este campo.

Respuesta de ejemplo (lista)

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

Respuesta de ejemplo (dispositivo único)

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

Eliminar

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

Eliminar la sobrescritura de canal de un dispositivo. El dispositivo volverá a usar su selección de canal normal; este endpoint no elimina el registro de metadatos del dispositivo.

Parámetros de solicitud o de consulta

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

Solicitud de ejemplo

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/

Respuesta de éxito

{
  "status": "ok"
}

Errores

Los errores utilizan un código de estado HTTP y un cuerpo JSON con error y message campos. Los códigos de error comunes incluyen:

• invalid_app_id cuando app_id no es un identificador de dominio inverso.
• device_not_found para un dispositivo desconocido de búsqueda.
• channel_not_found cuando el canal solicitado no existe.
• public_channel_override cuando se intenta sobreescribir un dispositivo a un canal público.
• invalid_version_id cuando se intenta realizar un override de paquete directo; utilice un canal en su lugar.
• cannot_access_app o cannot_access_channel o cuando la clave API carece de la permiso requerido.

Uso común

1. Mover un dispositivo de prueba a un canal de beta privado

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

2. Restablecer un dispositivo a la selección de canales normal

   Utilice el DELETE punto de conexión con los IDs de la aplicación y el dispositivo.

Sigue adelante desde Dispositivos

Si estás utilizando Dispositivos para planificar la ruta de canal y el lanzamiento en etapas, conecta con Canales para los detalles de implementación en Canales, Canales para los detalles de implementación en Canales, Canales para los detalles de implementación en Canales Solución de Pruebas Beta para el flujo de trabajo del producto en Solución de Pruebas Beta, y Solución de Enfoque de Versión para el flujo de trabajo del producto en Solución de Enfoque de Versión.