API

Concetti API

Comprendi autenticazione, attività asincrone e ciclo di vita dell'API di conversione dei documenti.

L'API Inkora è basata su REST, usa richieste e risposte JSON e autentica ogni richiesta con una chiave API Bearer.

URL di base e autenticazione

Tutti gli endpoint sono disponibili sotto https://fusion-api.oomol.com/v1. Invia la chiave API tramite l'header della richiesta Authorization.

text

Authorization: Bearer YOUR_API_KEY

Non esporre questa chiave nel codice frontend. Fai passare il lavoro avviato dal browser attraverso il tuo backend.

Ciclo di vita dell'attività asincrona

La conversione dei documenti è asincrona. Un endpoint di invio restituisce sessionID, l'identificativo di attività, e il corrispondente endpoint del risultato comunica uno di questi stati:

processing: il file è in attesa o in conversione.
completed: il risultato contiene l'URL di output generato in data.downloadURL e i metadati.
failed: il risultato contiene un motivo di errore che l'applicazione dovrebbe mostrare o registrare.

L'integrazione dovrebbe interrompere l'interrogazione a uno stato finale, usare tentativi limitati e conservare l'ID attività per supporto e recupero.

Endpoint

L'API attuale supporta la conversione da PDF a Markdown e da PDF a EPUB. Consulta il Riferimento API completo per percorsi, parametri, payload di esempio e guide SDK Python e TypeScript.