L'API
Il pannello ha un'API: i tuoi programmi possono creare clienti e subscription, sospenderle e riattivarle, cambiare piano, leggere i consumi, gestire gli apparati e i log di CSP (Central Syslog) e molto altro, senza passare dalle pagine. Serve soprattutto a un sistema di fatturazione, come WHMCS, che attiva e sospende i servizi con i pagamenti, o ai tuoi script di automazione.
Le persone non usano l'API: la usano gli account API, in Organizzazione › Account API. Un account API non può entrare nel pannello.
Creare un account API
- Nuovo account API: un Nome, per esempio "WHMCS", e un Ruolo.
- Crea l'account.
- Crea una chiave: un Nome della chiave, per esempio "Server di produzione", e una scadenza facoltativa (Scade).
La chiave viene mostrata una sola volta, appena creata: copiala subito e conservala in un posto sicuro. Il pannello non la mostra più.
Il ruolo
Il Ruolo decide che cosa può fare l'account, come per un utente. I ruoli sono gli stessi degli utenti: creane uno con solo le funzioni che servono al programma. Un sistema di fatturazione, per esempio, deve gestire clienti e subscription, ma non i backup.
Un account API agisce come un utente della tua organizzazione: vede i tuoi clienti e le loro subscription, non quelli degli altri.
Le chiavi
Un account può avere più chiavi. Dai a ogni programma o server la sua chiave, così puoi revocarne una senza fermare le altre.
Per ogni chiave la pagina mostra quando è stata Creata, quando Scade e l'Ultimo uso. Lascia vuota la scadenza per una chiave senza scadenza, e revocala quando non serve più.
- Revoca ferma subito una chiave: i programmi che la usano smettono di funzionare.
- Lo Stato dell'account su disattivato ferma tutte le sue chiavi finché non lo riattivi.
- Elimina l'account elimina l'account e le sue chiavi.
Se una chiave è finita dove non doveva, revocala e creane una nuova.
La documentazione delle chiamate
Documentazione dell'API, nella pagina Account API, apre la descrizione di tutte le chiamate, con i loro parametri e le risposte. È generata dal pannello stesso, quindi corrisponde sempre alla versione installata.
Alcune cose da sapere prima di scrivere un'integrazione:
- ogni chiamata porta la chiave nell'intestazione
Authorization: Bearer <chiave>; - le risposte sono in JSON, le date in UTC;
- c'è un limite di frequenza per chiave: oltre, il pannello chiede di aspettare;
- una richiesta di creazione può portare l'intestazione
Idempotency-Key, così ripeterla dopo un errore di rete non crea un doppione; - clienti e subscription possono avere un riferimento esterno, il codice del cliente o del servizio nel tuo sistema di fatturazione, con cui cercarli.
I dettagli sono nella documentazione dell'API.
Che cosa resta solo nel pannello
Il proprio account, gli utenti e i ruoli, il marchio e le notifiche si gestiscono solo dalle pagine del pannello.