Aplicaciones

Las aplicaciones son las entidades fundamentales en Capgo. Cada aplicación representa una aplicación Capacitor única que puede gestionar y actualizar a través de la plataforma. La API de Aplicaciones le permite crear, recuperar, actualizar y eliminar configuraciones de aplicaciones.

Comprendiendo las Aplicaciones

Una aplicación en Capgo representa su aplicación Capacitor e incluye:

• Aplicación ID: Identificador único para su aplicación
• Name: Nombre legible para humanos de su aplicación
• Icons: Identificadores visuales para su aplicación en el panel
• Configuración: Configuraciones que controlan cómo se entregan las actualizaciones
• Ownership: Información de acceso de organización y usuario
• Uso Estadísticas: Métricas sobre instalaciones y actualizaciones

Mejores Prácticas

1. Convención de Nomenclatura: Usar nombres claros e identificables para sus aplicaciones
2. Seguridad: Proteja sus claves API y credenciales de acceso
3. Organización: Agrupe aplicaciones relacionadas bajo la misma organización
4. Monitoreo: Revise regularmente las estadísticas y el rendimiento de las aplicaciones
5. Respaldo: Mantenga copias de seguridad de configuración para aplicaciones críticas

Endpoints

GET

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

Recuperar información sobre sus aplicaciones.

Parámetros de Consulta

• page: Opcional. Número de página para paginación
• limit: Opcional. Número de resultados por página (predeterminado: 50)
• org_id: Opcional. Filtrar aplicaciones por ID de organización. Si no se proporciona, devuelve aplicaciones de todas las organizaciones a las que el usuario tiene acceso

Para obtener una aplicación específica:

• Usar el ID de la aplicación en la ruta URL: https://api.capgo.app/app/:app_id

Tipo de Respuesta

interface App {
  app_id: string
  created_at: string | null
  default_upload_channel: string
  icon_url: string
  id: string | null
  last_version: string | null
  name: string | null
  owner_org: string
  retention: number
  transfer_history: Json[] | null
  updated_at: string | null
  user_id: string | null
}

Ejemplo de Solicitud

# Obtener todas las aplicaciones
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/"

# Obtener aplicaciones de una organización específica
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

# Obtener aplicación específica
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/com.demo.app"

Ejemplo de Respuesta

{
  "data": [
    {
      "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/

Crear una nueva aplicación.

Request Body

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

Ejemplo de Solicitud

# Crear nueva aplicación
curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New App",
    "app_id": "com.demo.myapp", // este ID es único en Capgo y no puede ser reutilizado por ninguna cuenta.
    "icon": "https://example.com/icon.png",
    "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
  }' \
  https://api.capgo.app/app/

Respuesta de Éxito

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

Actualizar una aplicación existente. El ID de la aplicación se especifica en la ruta URL.

Request Body

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

Ejemplo de Solicitud

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated App Name",
    "icon": "https://example.com/updated-icon.png",
    "retention": 45
  }' \
  https://api.capgo.app/app/com.demo.app

Respuesta de Éxito

{
  "app_id": "com.demo.app",
  "created_at": "2024-01-01T00:00:00Z",
  "default_upload_channel": "dev",
  "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"
}

Eliminar

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

Eliminar una aplicación y todos los recursos asociados. El ID de la aplicación se especifica en la ruta URL. Usar con extrema precaución ya que esta acción no se puede deshacer.

Ejemplo de Solicitud

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

Respuesta de Éxito

{
  "status": "ok"
}

Manejo de Errores

Escenarios de Error comunes y sus respuestas:

// Aplicación no encontrada
{
  "error": "App not found",
  "status": "KO"
}

// ID personalizado duplicado
{
  "error": "Custom ID already in use",
  "status": "KO"
}

// Parámetros inválidos
{
  "error": "Invalid app configuration",
  "status": "KO"
}

// Permiso denegado
{
  "error": "Insufficient permissions to manage app",
  "status": "KO"
}

// Acceso a organización denegado
{
  "status": "You do not have access to this organization"
}

Casos de Uso Comunes

1. Crear Nueva Aplicación

// Configurar una nueva aplicación
{
  "name": "Production App",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
}

2. Actualizar Configuración de Aplicación

// Cambiar nombre e icono de aplicación
{
  "name": "Rebranded App Name",
  "icon": "https://example.com/new-icon.png"
}

3. Establecer Política de Retención

// Configurar limpieza automática de paquetes
{
  "retention": 30 // Mantener paquetes por 30 días
}

4. Obtener Aplicaciones por Organización

# Listar todas las aplicaciones en una organización específica
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

Gestión de Recursos

1. Optimización de Almacenamiento: Monitoree el uso de almacenamiento y establezca políticas de retención apropiadas
2. Organización: Agrupe aplicaciones relacionadas bajo una sola organización
3. Control de Acceso: Gestione qué miembros del equipo pueden modificar la configuración de las aplicaciones
4. Estrategia de Respaldo: Respalde configuraciones y ajustes críticos de las aplicaciones