OpenAPI como fuente
Métodos, rutas y descripciones proceden del contrato OpenAPI descargable.
Capacidad
Referencia de la API REST
Consulta la API autenticada para cuentas, Cloud, carpetas, transformaciones, usuarios y webhooks.
Descripción
La referencia navegable nace del mismo contrato OpenAPI 3.1 usado por generadores y pruebas.
OpenAPI 3.1
Descargar OpenAPI 3.1Referencia de la API REST
Consulta la API autenticada para cuentas, Cloud, carpetas, transformaciones, usuarios y webhooks.
| HTTP | Path | Descripción |
|---|---|---|
| GET | /auth/me | Devuelve el usuario autenticado y metadatos seguros de la clave API. |
| GET | /account | Devuelve los datos de cuenta, reseller, suscripción y configuración Cloud efectiva. |
| PATCH | /account | Actualiza los datos básicos de la cuenta. |
| GET | /account/stats | Devuelve los totales de servicios, almacenamiento, versiones y vistas. |
| GET | /cloud/settings | Devuelve la configuración Cloud disponible para el rol autenticado. |
| PATCH | /cloud/settings | Actualiza la configuración Cloud global o la base de subcuentas según el rol. |
| GET | /cloud/catalog | Devuelve el catálogo permitido de servicios, extensiones y aplicaciones de subida. |
| GET | /cloud/services | Devuelve un listado paginado de servicios Cloud. |
| POST | /cloud/services | Crea un servicio Cloud editable. |
| POST | /cloud/files | Sube un archivo tras validar extensión, MIME detectado, tamaño y aplicación predeterminada. |
| GET | /cloud/services/{code} | Devuelve el detalle de un servicio Cloud. |
| PATCH | /cloud/services/{code} | Actualiza nombre, visibilidad, payload, carpeta o etiquetas. |
| DELETE | /cloud/services/{code} | Envía un servicio Cloud a la papelera. |
| GET | /cloud/services/{code}/content | Descarga con autenticación el archivo original o un resultado. |
| GET | /cloud/services/{code}/thumbnail | Devuelve Cloud servicios. |
| GET | /cloud/services/{code}/stats | Devuelve vistas, procedencias y actividad reciente del servicio. |
| POST | /cloud/services/{code}/move | Mueve un servicio Cloud a otra carpeta. |
| GET | /cloud/folders | Devuelve las carpetas accesibles. |
| POST | /cloud/folders | Crea una carpeta. |
| PATCH | /cloud/folders/{id} | Renombra, mueve o cambia la visibilidad de una carpeta. |
| DELETE | /cloud/folders/{id} | Envía una carpeta y su contenido a la papelera. |
| GET | /file-transformer/operations | Enumera las 154 operaciones públicas con sus formatos y parámetros. |
| GET | /file-transformer/operations/{operation} | Devuelve el contrato de una operación concreta. |
| POST | /file-transformer/estimates | Valida la entrada y estima los créditos antes de ejecutar. |
| GET | /file-transformer/jobs | Devuelve los trabajos de transformación asíncronos de la cuenta. |
| POST | /file-transformer/jobs | Crea y encola una transformación. |
| GET | /file-transformer/jobs/{id} | Devuelve el estado, progreso, consumo y resultados de un trabajo. |
| POST | /file-transformer/jobs/{id}/cancel | Cancela un trabajo que todavía está en cola. |
| POST | /file-transformer/jobs/{id}/retry | Crea un nuevo intento desde un trabajo fallido o cancelado. |
| GET | /users | Los administradores listan usuarios; los resellers, sus subcuentas. |
| POST | /users | Crea un usuario o una subcuenta. |
| GET | /users/{id} | Devuelve el detalle de un usuario gestionable. |
| PATCH | /users/{id} | Actualiza un usuario gestionable. |
| PATCH | /users/{id}/cloud-settings | Personaliza Cloud para un usuario gestionable. |
| GET | /webhooks | Devuelve los endpoints webhook de la cuenta. |
| POST | /webhooks | Crea un endpoint webhook universal. |
| GET | /webhooks/{id} | Devuelve el detalle de un endpoint webhook. |
| PATCH | /webhooks/{id} | Actualiza URL, eventos o estado, o rota el secreto. |
| DELETE | /webhooks/{id} | Elimina un endpoint webhook. |
| POST | /webhooks/{id}/test | Encola una entrega de prueba al endpoint. |
| GET | /webhooks/{id}/deliveries | Devuelve el historial paginado de entregas de un endpoint. |
| POST | /webhook-deliveries/{id}/retry | Vuelve a encolar manualmente una entrega webhook. |
| GET | /ai/providers | Enumera IA proveedores. |
| POST | /ai/estimates | Crea IA estimaciones. |
| GET | /ai/text/generations | Enumera IA texto generaciones. |
| POST | /ai/text/generations | Crea IA texto generaciones. |
| GET | /ai/media/generations | Enumera IA contenido multimedia generaciones. |
| POST | /ai/media/generations | Crea IA contenido multimedia generaciones. |
| GET | /plans | Enumera planes. |
| POST | /plans/custom/estimates | Crea planes personalizados estimaciones. |
| GET | /billing/usage | Devuelve facturación consumo. |
| GET | /billing/credit-consumptions | Enumera facturación consumos de créditos. |
| GET | /billing/tariffs | Enumera facturación tarifas. |
| GET | /billing/subscription | Devuelve facturación suscripción. |
| POST | /billing/subscriptions/plan/{plan} | Crea facturación suscripciones. |
| POST | /billing/subscriptions/custom | Crea facturación suscripciones personalizados. |
| POST | /billing/subscriptions/{subscription}/renew | Renueva facturación suscripciones. |
| DELETE | /billing/subscriptions/{subscription} | Elimina facturación suscripciones. |
| GET | /billing/transactions | Enumera facturación transacciones. |
| GET | /billing/transactions/{id} | Devuelve facturación transacciones. |
| POST | /billing/transactions/{id}/cancel | Cancela facturación transacciones. |
| POST | /billing/transactions/{id}/retry | Reintenta facturación transacciones. |
| POST | /billing/transactions/{id}/reconcile | Concilia facturación transacciones. |
| GET | /billing/invoices | Enumera facturación facturas. |
| GET | /billing/invoices/{invoice} | Devuelve facturación facturas. |
| GET | /billing/invoices/{invoice}/pdf | Devuelve facturación facturas. |
| GET | /cloud/services/{code}/versions | Enumera Cloud versiones. |
| GET | /cloud/services/{code}/versions/{version}/download | Devuelve Cloud versiones. |
| POST | /cloud/services/{code}/versions/{version}/restore | Restaura Cloud versiones. |
| GET | /cloud/services/{code}/permissions | Devuelve Cloud servicios permisos. |
| PUT | /cloud/services/{code}/permissions | Actualiza Cloud servicios permisos. |
| GET | /cloud/folders/{folder}/permissions | Devuelve Cloud carpetas permisos. |
| PUT | /cloud/folders/{folder}/permissions | Actualiza Cloud carpetas permisos. |
| GET | /cloud/imports/providers | Enumera Cloud importaciones proveedores. |
| GET | /cloud/imports/connections | Enumera Cloud importaciones conexiones. |
| GET | /cloud/imports/{provider}/authorization | Devuelve Cloud importaciones autorización. |
| POST | /cloud/imports/{provider}/connections | Crea Cloud importaciones conexiones. |
| DELETE | /cloud/imports/connections/{provider} | Elimina Cloud importaciones conexiones. |
| GET | /cloud/imports/{provider}/browse | Devuelve Cloud importaciones. |
| POST | /cloud/imports/{provider}/jobs | Crea Cloud importaciones. |
| GET | /cloud/import-jobs | Enumera Cloud trabajos de importación. |
| GET | /cloud/import-jobs/{job} | Devuelve Cloud trabajos de importación. |
| GET | /cloud/services/{code}/survey/responses | Enumera Cloud encuesta respuestas. |
| GET | /cloud/services/{code}/poll/results | Devuelve Cloud votación resultados. |
| GET | /cloud/services/{code}/event/attendees | Enumera Cloud evento asistentes. |
| PATCH | /cloud/services/{code}/event/attendees/{attendee} | Actualiza Cloud evento asistentes. |
| GET | /cloud/services/{code}/signature/tracking | Devuelve Cloud firma seguimiento. |
| GET | /marketplace/services | Enumera marketplace servicios. |
| GET | /marketplace/services/{service} | Devuelve marketplace servicios. |
| POST | /marketplace/services/{service}/installations | Crea marketplace instalaciones. |
| DELETE | /marketplace/services/{service}/installations | Elimina marketplace instalaciones. |
| POST | /marketplace/installations/{installation}/launch | Inicia marketplace instalaciones. |
| GET | /marketplace/partner/services | Enumera marketplace partner servicios. |
| POST | /marketplace/partner/services | Crea marketplace partner servicios. |
| PUT | /marketplace/partner/services/{service} | Actualiza marketplace partner servicios. |
| DELETE | /marketplace/partner/services/{service} | Elimina marketplace partner servicios. |
| POST | /marketplace/partner/services/{service}/submit | Devuelve marketplace partner servicios. |
Funcionalidades
Qué permite hacer Referencia de la API REST
Autenticación por permisos
Cada operación protegida identifica el alcance mínimo necesario.
Reintentos seguros
Las claves de idempotencia evitan duplicados accidentales en escrituras compatibles.
Transformaciones asíncronas
Estima, crea, supervisa, cancela y reintenta trabajos de File Transformer.
Eventos firmados
Crea webhooks, inspecciona entregas y reintenta fallos transitorios.
Alcance explícito
Editores, respuestas, asistentes, firmas e IA no se consideran expuestos si no hay endpoint.
Preguntas frecuentes
Preguntas frecuentes sobre Referencia de la API REST
No. Esta referencia es la lista autoritativa; lo no listado sigue siendo un flujo del área de usuario.
Sí. El JSON OpenAPI 3.1 continúa disponible para herramientas y validación.
Utiliza una clave con alcance mínimo y una clave de idempotencia cuando la operación la admita.