API per sviluppatori
Richiama gli strumenti dal tuo software senza browser: invia una richiesta, avvia un job e scarica l'output. Tutti gli endpoint si trovano a un unico indirizzo con versione; ogni richiesta è autorizzata con una chiave personale.
Flusso dei job
Una chiamata avvia un job di conversione e restituisce un ID del job. Con tale ID controlli lo stato del job e scarichi l'output una volta completato. I job possono richiedere tempo, quindi questa suddivisione permette ai client di attendere senza bloccare il proprio flusso.
Chiave e accesso
Le richieste sono firmate con l'header Authorization: Bearer. Crea la tua chiave nel tuo account e revocala quando vuoi; la chiave in chiaro viene mostrata solo al momento della creazione. Una sessione del browser qui non vale come autenticazione.
Strumenti con API aperta
| Strumento | Superficie API | Documento |
|---|---|---|
| ImmagineMini | Convertitore — POST /run | Documento |
| Registro Entrate-Uscite | 10 endpoint (app stateful) | Documento |
| PdfSplit | Convertitore — POST /run | Documento |
Versionamento e contratto
Gli endpoint sono versionati sotto https://api.pixepi.com con /api/v1; una modifica non retrocompatibile richiede una nuova versione. Il contratto machine-readable è pubblicato come OpenAPI 3.1 e può essere fornito direttamente ai generatori di client.
Risposte ed errori
Le risposte sono racchiuse in un envelope JSON; ogni job viene interrogato tramite il proprio ID e la proprietà del record viene verificata sul server. Quando qualcosa va storto, la risposta restituisce un codice che descrive lo stato; il client traduce quel codice nella propria lingua.
Approfondimenti
- Il link alle API sulla pagina dello strumento scelto; mostra endpoint, campi di richiesta, opzioni e gestione degli errori di tale strumento.
- Contratto machine-readable: documento OpenAPI.
- Pagina centrale per sviluppatori: l'elenco condiviso di tutti gli endpoint.