Skip to content
Esta página fue generada y traducida con asistencia de IA. Si encuentra alguna imprecisión, no dude en ayudar a mejorarla. Editar en GitHub

Descripción General de la API

Fenfa expone una API REST para subir builds, gestionar productos y consultar analíticas. Todas las interacciones programáticas -- desde subidas de CI/CD hasta operaciones del panel de administración -- pasan por esta API.

URL Base

Todos los endpoints de la API son relativos a la URL de tu servidor Fenfa:

https://your-domain.com

Autenticación

Los endpoints protegidos requieren un encabezado X-Auth-Token. Fenfa usa dos ámbitos de token:

ÁmbitoPuede HacerEncabezado
uploadSubir buildsX-Auth-Token: YOUR_UPLOAD_TOKEN
adminAcceso completo de administrador (incluye subida)X-Auth-Token: YOUR_ADMIN_TOKEN

Los tokens se configuran en config.json o via variables de entorno. Ver Configuración.

WARNING

Las solicitudes a endpoints protegidos sin un token válido reciben una respuesta 401 Unauthorized.

Formato de Respuesta

Todas las respuestas JSON siguen una estructura unificada:

Éxito:

json
{
  "ok": true,
  "data": { ... }
}

Error:

json
{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "variant_id is required"
  }
}

Códigos de Error

CódigoEstado HTTPDescripción
BAD_REQUEST400Parámetros de solicitud inválidos
UNAUTHORIZED401Token de autenticación ausente o inválido
FORBIDDEN403El token carece del ámbito requerido
NOT_FOUND404Recurso no encontrado
INTERNAL_ERROR500Error del servidor

Resumen de Endpoints

Endpoints Públicos (Sin Auth)

MétodoRutaDescripción
GET/products/:slugPágina de descarga del producto (HTML)
GET/d/:releaseIDDescarga directa de archivo
GET/ios/:releaseID/manifest.plistManifiesto OTA de iOS
GET/udid/profile.mobileconfig?variant=:idPerfil de vinculación UDID
POST/udid/callbackCallback UDID (desde iOS)
GET/udid/status?variant=:idEstado de vinculación UDID
GET/healthzComprobación de salud

Endpoints de Subida (Token de Subida)

MétodoRutaDescripción
POST/uploadSubir un archivo de build

Endpoints de Administración (Token de Admin)

MétodoRutaDescripción
POST/admin/api/smart-uploadSubida inteligente con detección automática
GET/admin/api/productsListar productos
POST/admin/api/productsCrear producto
GET/admin/api/products/:idObtener producto con variantes
PUT/admin/api/products/:idActualizar producto
DELETE/admin/api/products/:idEliminar producto
POST/admin/api/products/:id/variantsCrear variante
PUT/admin/api/variants/:idActualizar variante
DELETE/admin/api/variants/:idEliminar variante
GET/admin/api/variants/:id/statsEstadísticas de variante
DELETE/admin/api/releases/:idEliminar versión
PUT/admin/api/apps/:id/publishPublicar app
PUT/admin/api/apps/:id/unpublishDespublicar app
GET/admin/api/eventsConsultar eventos
GET/admin/api/ios_devicesListar dispositivos iOS
POST/admin/api/devices/:id/register-appleRegistrar dispositivo con Apple
POST/admin/api/devices/register-appleRegistro en lote de dispositivos
GET/admin/api/settingsObtener ajustes
PUT/admin/api/settingsActualizar ajustes
GET/admin/api/upload-configObtener configuración de subida
GET/admin/api/apple/statusEstado de la API de Apple
GET/admin/api/apple/devicesDispositivos registrados en Apple

Endpoints de Exportación (Token de Admin)

MétodoRutaDescripción
GET/admin/exports/releases.csvExportar versiones
GET/admin/exports/events.csvExportar eventos
GET/admin/exports/ios_devices.csvExportar dispositivos iOS

Formato de ID

Todos los IDs de recursos usan un formato de prefijo + cadena aleatoria:

PrefijoRecurso
prd_Producto
var_Variante
rel_Versión
app_App (heredado)

Referencias Detalladas

Released under the Apache-2.0 License.