Documentazione

Client API

Atheneo Pro espone API HTTP in rete locale, pensate per integrare il prodotto con gli altri strumenti dello studio. Tutte le chiamate restano sulla LAN: non passano da servizi esterni.

Autenticazione

  • Token JWT (Bearer) per le sessioni interattive, ottenuto tramite login.
  • API key per le integrazioni applicative e i processi automatici. Le chiavi sono conservate in forma cifrata lato server e possono avere ambito ridotto (sola lettura/query).

L’header tipico per una richiesta autenticata è:

Authorization: Bearer <token-jwt>

oppure, con una API key:

X-API-Key: <api-key>

Ruoli e permessi (RBAC)

L’accesso è governato da ruoli: owner, admin, librarian e member. Ogni ruolo abilita un sottoinsieme di operazioni: assegna alle integrazioni il ruolo con i privilegi minimi necessari.

SDK ufficiali

Oltre alle chiamate HTTP dirette, sono disponibili SDK client per Python e TypeScript/JavaScript, che coprono le operazioni principali (interrogazione, chat, gestione documenti) con gestione degli errori tipizzata.

Uso di base

  1. Ottieni una credenziale (token JWT o API key) con il ruolo adeguato.
  2. Indirizza le richieste all’endpoint del server sulla rete locale.
  3. Includi l’header di autorizzazione in ogni chiamata.
  4. Gestisci scadenza e rotazione delle credenziali secondo le policy dello studio.

Specifica navigabile

Una specifica OpenAPI / Swagger interattiva è prevista come evoluzione futura. Gli endpoint completi e gli schemi di richiesta/risposta sono comunque nella documentazione consegnata.

Il riferimento API completo viene fornito allo studio in fase di setup, allineato alla versione installata.

← Torna alla documentazione