API Keys

SIP Caller ti permette di definire API Key per integrarlo con sistemi esterni. Puoi definire tutte le API Key di cui hai bisogno, assegnando una scadenza e dei ruoli. Un sistema esterno può utilizzare la REST API fornita da SIP Caller, autenticandosi con il Token dell'API Key generato come descritto di seguito.

Le API Key richiedono il piano Enterprise.

Ruoli richiesti

Per creare o modificare una API Key, l'utente necessita di uno dei seguenti ruoli:

• Amministratore

Per visualizzare una API Key, l'utente necessita di uno dei seguenti ruoli:

• Lettore Account

Crea una API Key

Per creare una API Key:

1. Vai su "Impostazioni" > "API Keys", e poi fai clic su "Crea".
   
2. Specifica un nome per la API Key.
3. Seleziona una scadenza. Nota che questa non può essere estesa una volta creata la API Key.
4. Abilita i ruoli che vuoi concedere alle applicazioni che utilizzeranno questa API Key. Nota che questi non possono essere modificati una volta creata la API Key. I ruoli disponibili sono descritti in Ruoli delle API Key.
5. Fai clic su "Salva" per creare la API Key.
   
6. Verrà mostrata una finestra di dialogo, contenente il Token per la API Key appena creata. Copia il valore e salvalo in un posto sicuro. Questo token non verrà mostrato di nuovo, e non può essere recuperato, poiché SIP Caller non lo memorizzerà. Se lo perdi, dovrai creare un'altra API Key.

Ruoli delle API Key

I ruoli assegnati a una API Key definiscono cosa possono fare le applicazioni che la utilizzano. I ruoli disponibili sono i seguenti:

• Monitor Code Sistema Telefonico: questo ruolo è richiesto per utilizzare il modulo SIP Caller Queues Monitor e monitorare il tuo sistema telefonico in tempo reale, per le campagne eseguite in modalità dialer predittivo o progressivo. Può essere limitato a sistemi telefonici specifici.
• Lettore Campagne: questo ruolo permette l'accesso in sola lettura a campagne, numeri delle campagne, liste nere, elenchi di contatti e rapporti delle campagne.
• Amministratore Campagne: questo ruolo permette l'accesso completo a campagne, numeri delle campagne, liste nere, elenchi di contatti e rapporti delle campagne.
• Amministratore Numeri Campagna: questo ruolo permette di leggere, aggiungere e rimuovere i numeri di una campagna. Può essere limitato a campagne specifiche.
• Fornitore Numeri Campagna: questo ruolo permette di aggiungere numeri a una campagna, senza poterli leggere o rimuovere. Può essere limitato a campagne specifiche.

Concedi a ogni applicazione solo i ruoli di cui ha bisogno. Ad esempio, un modulo web che invia nuovi contatti a una campagna ha bisogno solo del ruolo Fornitore Numeri Campagna, limitato a quella campagna. Consulta la documentazione per sviluppatori per maggiori dettagli.

Modifica una API Key

Per modificare una API Key:

1. Vai su "Impostazioni" > "API Keys", e poi fai clic sulla API Key che vuoi modificare.
   
2. A questo punto, puoi modificare solo il nome, e visualizzare la data e l'ora di creazione e scadenza, e i ruoli assegnati alla API Key. Se hai bisogno di modificare altri valori, dovrai creare un'altra API Key.

Elimina una API Key

Quando hai bisogno di revocare l'accesso di un'applicazione a SIP Caller, dovrai eliminare la API Key. Per farlo:

1. Vai su "Impostazioni" > "API Keys", e poi seleziona la API Key che vuoi eliminare.
2. Fai clic sul pulsante Elimina e conferma l'operazione.