Dispositivos

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

Dos políticas de 90 días.

Inventario de dispositivos: Los registros de dispositivo se retienen durante 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 refrescar sus metadatos.

Overrides de canal: un override POST se elimina 90 días después de la última escritura de override, incluso si el dispositivo sigue realizando comprobaciones. Realizar comprobaciones no reinicia ese reloj. Para evitar esa eliminación, establezca defaultChannel en Capacitor configuración (sobrevive a la reinstalación) o llamar setChannel() desde la aplicación. En el plugin 5.34.0 / 6.34.0 / 7.34.0 / 8.0.0 y posteriormente setChannel() es local y se elimina a la reinstalación, por lo que la aplicación debe llamarlo de nuevo. Los plugins antiguos escriben una sobrescritura de backend que sobrevive a la reinstalación y se elimina por esta limpieza. Consulte la consola y API sobrescripciones expiran después de 90 días.

Metadata del dispositivo

Each record can include the device ID, platform, updater and OS versions, native build, installed bundle, production and emulator state, custom ID, and channel override.

Cuando esté disponible country_code es la última code válida de dos letras ISO 3166-1 recibida de una Cloudflare-manejada solicitud para el dispositivo. No es GPS ni un valor de ubicación proporcionado por tu aplicación. Puede ser null utilice un lookup de dispositivo único cuando este campo no esté disponible.

Puntos finales

POST

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

Set a device-specific override to a privado canal. Para elegir un paquete para un dispositivo, asigna ese paquete al canal; no se admiten sobrescripciones de paquetes por dispositivo directas. La sobrescritura caduca 90 días después de la última escritura a menos que vuelvas a enviar un POST.

Solicitud de cuerpo

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

Ejemplo de solicitud

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/

Los canales públicos no pueden usarse como sobreescripciones de dispositivo.

Respuesta de éxito

{
  "status": "ok"
}

GET

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

Obtener metadatos de dispositivo. Los resultados están paginados con cursor cuando omites device_id.

Parámetros de consulta

• app_idID de aplicación de dominio inverso requerido, 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 valor no vacío custom_id.
• cursor: Cursor opcional desde la respuesta de la lista anterior.
• limit: Número opcional de dispositivos por página.

Pedidos de ejemplo

# 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 is populated by a device-specific lookup when Capgo has stored a valid Cloudflare-derived country code. Requests without a valid country do not clear the last valid value; list responses may return 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 individual)

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

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

Cuerpo de solicitud o parámetros 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/

Solicitud de ejemplo

{
  "status": "ok"
}

Errors

Errores utilizan un estado de error HTTP y un cuerpo JSON con error and message códigos de error comunes incluyen:

• invalid_app_id cuando app_id no es un identificador de dominio inverso.
• device_not_found para una búsqueda de dispositivo desconocido.
• 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 sobreescribir un paquete directo; utilice un canal en su lugar.
• cannot_access_app o cannot_access_channel cuando la clave API no tiene la permiso requerido.

Casos de uso comunes

1. Título de la sección: Uso común

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

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

   Utilice el DELETE endpoint with the app and device IDs.

Siga adelante desde Dispositivos

Si está utilizando Dispositivos conectarlo para planificar la ruta de canal y el despliegue en etapas Channels para los detalles de implementación en los canales, Channels para los detalles de implementación en los 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 Alcance de Versión para el flujo de trabajo del producto en Solución de Alcance de Versión.