Aplicaciones

Apps are the foundational entities in Capgo. Each app represents a unique Capacitor application that you can manage and update through the platform. The Apps API allows you to create, retrieve, update, and delete app configurations.

Entendiendo aplicaciones

An app in Capgo represents your Capacitor application and includes:

• ID de aplicación: Identificador único de tu aplicación
• Nombre: Nombre legible por humanos de tu aplicación
• Iconos: Identificadores visuales para tu aplicación en la consola
• Configuración: Configuraciones que controlan cómo se entregan las actualizaciones
• Propiedad: Información de acceso de organización y usuario
• Estadísticas de Uso: Métricas sobre instalaciones y actualizaciones

Prácticas Recomendadas

1. Convención de Nombres: Utilice 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: Verifique regularmente estadísticas y rendimiento de aplicaciones
5. Backup: Mantenga copias de seguridad de configuraciones para aplicaciones críticas

Puntos de Acceso

GET

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

Obtenga información sobre sus aplicaciones.

Parámetros de consulta

• pagePágina: Opcional. Número de página para paginación
• limitResultados por página: Opcional. Número de resultados por página (por defecto: 50)
• org_idOrganización ID: Opcional. Filtra 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:

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

Tipo de respuesta

Nota: last_version se refiere a la última compilación (versión) subida para la aplicación.

interface App {
  app_id: string
  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
}

Solicitud de ejemplo

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

Respuesta de ejemplo

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

__CAPGO_KEEP_0__

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

Solicitud de ejemplo

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

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

Actualizar

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

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

Cuerpo de la solicitud

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

Solicitud de ejemplo

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

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

Solicitud de ejemplo

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

Respuesta de éxito

{
  "status": "ok"
}

Gestión de errores

Escenarios de errores comunes y sus respuestas:

// App not found
{
  "error": "App not found",
  "status": "KO"
}

// Duplicate custom ID
{
  "error": "Custom ID already in use",
  "status": "KO"
}

// Invalid parameters
{
  "error": "Invalid app configuration",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage app",
  "status": "KO"
}

// Organization access denied
{
  "status": "You do not have access to this organization"
}

Uso común

1. Crear nueva aplicación

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

2. Actualizar configuración de la aplicación

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

3. Establecer política de retención

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

4. Obtener aplicaciones por organización

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

Gestión de recursos

1. Optimización de almacenamiento: Supervise el uso de almacenamiento y establezca políticas de retención adecuadas
2. Organización: Agrupe aplicaciones relacionadas bajo una sola organización
3. Control de acceso: Administre qué miembros del equipo pueden modificar ajustes de la aplicación
4. Estrategia de respaldo: Realice copias de seguridad de configuraciones y ajustes de la aplicación críticos