OpenAPI come sorgente
Metodi, percorsi e descrizioni delle operazioni provengono dal contratto OpenAPI scaricabile.
Capacità
Riferimento API REST
Consulta l’API per account, Cloud, cartelle, trasformazioni, utenti e webhook.
Descrizione
Il riferimento navigabile deriva dallo stesso contratto OpenAPI 3.1.
OpenAPI 3.1
Scarica OpenAPI 3.1Riferimento API REST
Consulta l’API per account, Cloud, cartelle, trasformazioni, utenti e webhook.
| HTTP | Path | Descrizione |
|---|---|---|
| GET | /auth/me | Restituisce l’utente autenticato e i metadati sicuri della chiave API. |
| GET | /account | Restituisce account, reseller, abbonamento e configurazione Cloud effettiva. |
| PATCH | /account | Aggiorna i dati di base dell’account. |
| GET | /account/stats | Restituisce i totali di servizi, spazio, versioni e visualizzazioni. |
| GET | /cloud/settings | Restituisce la configurazione Cloud disponibile per il ruolo autenticato. |
| PATCH | /cloud/settings | Aggiorna la configurazione Cloud globale o la base dei sottoaccount in base al ruolo. |
| GET | /cloud/catalog | Restituisce il catalogo consentito di servizi, estensioni e app di caricamento. |
| GET | /cloud/services | Restituisce un elenco paginato dei servizi Cloud. |
| POST | /cloud/services | Crea un servizio Cloud modificabile. |
| POST | /cloud/files | Carica un file dopo aver verificato estensione, MIME rilevato, dimensione e app predefinita. |
| GET | /cloud/services/{code} | Restituisce i dettagli di un servizio Cloud. |
| PATCH | /cloud/services/{code} | Aggiorna nome, visibilità, payload, cartella o tag. |
| DELETE | /cloud/services/{code} | Sposta un servizio Cloud nel cestino. |
| GET | /cloud/services/{code}/content | Scarica con autenticazione il file originale o un risultato. |
| GET | /cloud/services/{code}/thumbnail | Restituisce Cloud servizi. |
| GET | /cloud/services/{code}/stats | Restituisce visualizzazioni, provenienze e attività recente del servizio. |
| POST | /cloud/services/{code}/move | Sposta un servizio Cloud in un’altra cartella. |
| GET | /cloud/folders | Restituisce le cartelle accessibili. |
| POST | /cloud/folders | Crea una cartella. |
| PATCH | /cloud/folders/{id} | Rinomina, sposta o modifica la visibilità di una cartella. |
| DELETE | /cloud/folders/{id} | Sposta una cartella e il suo contenuto nel cestino. |
| GET | /file-transformer/operations | Elenca tutte le 154 operazioni pubbliche con formati e parametri. |
| GET | /file-transformer/operations/{operation} | Restituisce il contratto di un’operazione specifica. |
| POST | /file-transformer/estimates | Convalida l’input e stima i crediti prima dell’esecuzione. |
| GET | /file-transformer/jobs | Restituisce i processi di trasformazione asincroni dell’account. |
| POST | /file-transformer/jobs | Crea e accoda una trasformazione. |
| GET | /file-transformer/jobs/{id} | Restituisce stato, avanzamento, consumo e risultati di un processo. |
| POST | /file-transformer/jobs/{id}/cancel | Annulla un processo ancora in coda. |
| POST | /file-transformer/jobs/{id}/retry | Crea un nuovo tentativo da un processo non riuscito o annullato. |
| GET | /users | Gli amministratori elencano gli utenti; i reseller elencano i propri sottoaccount. |
| POST | /users | Crea un utente o un sottoaccount. |
| GET | /users/{id} | Restituisce i dettagli di un utente gestibile. |
| PATCH | /users/{id} | Aggiorna un utente gestibile. |
| PATCH | /users/{id}/cloud-settings | Personalizza Cloud per un utente gestibile. |
| GET | /webhooks | Restituisce gli endpoint webhook dell’account. |
| POST | /webhooks | Crea un endpoint webhook universale. |
| GET | /webhooks/{id} | Restituisce i dettagli di un endpoint webhook. |
| PATCH | /webhooks/{id} | Aggiorna URL, eventi o stato oppure ruota il segreto. |
| DELETE | /webhooks/{id} | Elimina un endpoint webhook. |
| POST | /webhooks/{id}/test | Accoda una consegna di prova all’endpoint. |
| GET | /webhooks/{id}/deliveries | Restituisce la cronologia paginata delle consegne di un endpoint. |
| POST | /webhook-deliveries/{id}/retry | Riaccoda manualmente una consegna webhook. |
| GET | /ai/providers | Elenca IA provider. |
| POST | /ai/estimates | Crea IA stime. |
| GET | /ai/text/generations | Elenca IA testo generazioni. |
| POST | /ai/text/generations | Crea IA testo generazioni. |
| GET | /ai/media/generations | Elenca IA contenuti multimediali generazioni. |
| POST | /ai/media/generations | Crea IA contenuti multimediali generazioni. |
| GET | /plans | Elenca piani. |
| POST | /plans/custom/estimates | Crea piani personalizzati stime. |
| GET | /billing/usage | Restituisce fatturazione consumo. |
| GET | /billing/credit-consumptions | Elenca fatturazione consumi di crediti. |
| GET | /billing/tariffs | Elenca fatturazione tariffe. |
| GET | /billing/subscription | Restituisce fatturazione abbonamento. |
| POST | /billing/subscriptions/plan/{plan} | Crea fatturazione abbonamenti. |
| POST | /billing/subscriptions/custom | Crea fatturazione abbonamenti personalizzati. |
| POST | /billing/subscriptions/{subscription}/renew | Rinnova fatturazione abbonamenti. |
| DELETE | /billing/subscriptions/{subscription} | Elimina fatturazione abbonamenti. |
| GET | /billing/transactions | Elenca fatturazione transazioni. |
| GET | /billing/transactions/{id} | Restituisce fatturazione transazioni. |
| POST | /billing/transactions/{id}/cancel | Annulla fatturazione transazioni. |
| POST | /billing/transactions/{id}/retry | Riprova fatturazione transazioni. |
| POST | /billing/transactions/{id}/reconcile | Riconcilia fatturazione transazioni. |
| GET | /billing/invoices | Elenca fatturazione fatture. |
| GET | /billing/invoices/{invoice} | Restituisce fatturazione fatture. |
| GET | /billing/invoices/{invoice}/pdf | Restituisce fatturazione fatture. |
| GET | /cloud/services/{code}/versions | Elenca Cloud versioni. |
| GET | /cloud/services/{code}/versions/{version}/download | Restituisce Cloud versioni. |
| POST | /cloud/services/{code}/versions/{version}/restore | Ripristina Cloud versioni. |
| GET | /cloud/services/{code}/permissions | Restituisce Cloud servizi permessi. |
| PUT | /cloud/services/{code}/permissions | Aggiorna Cloud servizi permessi. |
| GET | /cloud/folders/{folder}/permissions | Restituisce Cloud cartelle permessi. |
| PUT | /cloud/folders/{folder}/permissions | Aggiorna Cloud cartelle permessi. |
| GET | /cloud/imports/providers | Elenca Cloud importazioni provider. |
| GET | /cloud/imports/connections | Elenca Cloud importazioni connessioni. |
| GET | /cloud/imports/{provider}/authorization | Restituisce Cloud importazioni autorizzazione. |
| POST | /cloud/imports/{provider}/connections | Crea Cloud importazioni connessioni. |
| DELETE | /cloud/imports/connections/{provider} | Elimina Cloud importazioni connessioni. |
| GET | /cloud/imports/{provider}/browse | Restituisce Cloud importazioni. |
| POST | /cloud/imports/{provider}/jobs | Crea Cloud importazioni. |
| GET | /cloud/import-jobs | Elenca Cloud processi di importazione. |
| GET | /cloud/import-jobs/{job} | Restituisce Cloud processi di importazione. |
| GET | /cloud/services/{code}/survey/responses | Elenca Cloud sondaggio risposte. |
| GET | /cloud/services/{code}/poll/results | Restituisce Cloud votazione risultati. |
| GET | /cloud/services/{code}/event/attendees | Elenca Cloud evento partecipanti. |
| PATCH | /cloud/services/{code}/event/attendees/{attendee} | Aggiorna Cloud evento partecipanti. |
| GET | /cloud/services/{code}/signature/tracking | Restituisce Cloud firma monitoraggio. |
| GET | /marketplace/services | Elenca marketplace servizi. |
| GET | /marketplace/services/{service} | Restituisce marketplace servizi. |
| POST | /marketplace/services/{service}/installations | Crea marketplace installazioni. |
| DELETE | /marketplace/services/{service}/installations | Elimina marketplace installazioni. |
| POST | /marketplace/installations/{installation}/launch | Avvia marketplace installazioni. |
| GET | /marketplace/partner/services | Elenca marketplace partner servizi. |
| POST | /marketplace/partner/services | Crea marketplace partner servizi. |
| PUT | /marketplace/partner/services/{service} | Aggiorna marketplace partner servizi. |
| DELETE | /marketplace/partner/services/{service} | Elimina marketplace partner servizi. |
| POST | /marketplace/partner/services/{service}/submit | Restituisce marketplace partner servizi. |
Funzionalità
Cosa permette di fare Riferimento API REST
Autenticazione con ambito
Ogni operazione protetta identifica l'ambito con privilegi minimi richiesto dal suo percorso.
Tentativi di scrittura sicuri
Le chiavi di idempotenza proteggono le scritture supportate dalla duplicazione accidentale dopo i tentativi di rete.
Trasformazioni asincrone
Crea, stima, monitora, annulla e riprova i lavori di File Transformer.
Consegna dell'evento firmato
Crea endpoint webhook, controlla le consegne e riprova gli errori temporanei.
Ambito funzionale esplicito
Editor specializzati, risposte ai sondaggi, gestione dei partecipanti, firme e generazione di intelligenza artificiale non sono implicati a meno che non venga elencato un endpoint.
Domande frequenti
Domande su Riferimento API REST
No. Il riferimento è l'elenco autorevole; gli editor non elencati e le operazioni specifiche del servizio rimangono flussi di lavoro dell'interfaccia dell'account.
Sì. Il JSON OpenAPI 3.1 rimane disponibile per generatori, convalida e strumenti locali.
Utilizza una chiave API con ambito ristretto e una chiave di idempotenza per le operazioni di scrittura supportate.