INDICE
Concedere l'accesso all'utilizzo delle API
Prima di poter attivare i ticket per un utente specifico (consulta prima la guida di riferimento OneCloud API), è necessario autorizzarlo a livello di configurazione dell'organizzazione.
Questo può essere fatto accedendo al portale admin dell'organizzazione.
- Accedi al portale OneCloud con privilegi Admin
- Naviga nella sezione Services
- Seleziona External API authorization
- Puoi scegliere di applicare questa configurazione su diversi livelli:
- Organization
- User Group
- User
- In questo esempio concediamo l'accesso ad un utente specifico, quindi ricerchiamo l'utente e selezioniamolo.
- Una volta selezionato l'utente desiderato, puoi concedere l'accesso a specifiche API End User. In questo esempio l'utente riceve l'accesso a tutte le API come mostrato nella seguente immagine.
Creare un ticket API End User
Il ticket API dell'utente finale può essere generato dal portale OneCloud ( onecloud.setera.com ) accedendo come utente.
- Assicurarsi che sia attiva la User view qualora l'utente abbia anche privilegi Admin
- Naviga nella sezione Home
- Seleziona la voce Tickets
- Inserisci un nome e seleziona le API per la quale si vuole ottenere l'accesso. In questo esempio viene consentito Queue statistics e SMS
- Una volta creato il ticket, questo verrà elencato tra i Ticket Concessi e mostrerà il Token necessario per l'autenticazione Bearer e la data di scadenza.
Eventualmente può anche essere revocato cliccando sull'apposito pulsante.
Test API End User
- E' possibile testare le API End User al seguente link: https://www.setera.com/officeplus/enduser/ (Obsoleto)
- La documentazione più aggiornata è invece disponibile al seguente link: https://www.setera.com/onecloud/enduser.html
- Localizza il pulsante Authorize ed inserisci il tuo Token come bearer and clicca su Authorize
- Localizza l'API che si vuole testare e per la quale si ha l'autorizzazione, in questo caso queue/statistics e clicca sul pulsante Try it out.
- Inserisci i campi obbligatori richiesti, in questo caso domain and user. (Nel nostro esempio utilizzeremo setera.com come dominio dell'organizzazione e aki.huolman come utente)
- Clicca sul tasto Execute dovresti visualizzare la sezione Responses. Sarà possibile inoltre selezionare il formato del payload che verrà restituito dal server, in questo caso application/json.
Swagger genera anche l'anteprima del comando cURL che assomiglierà al seguente:curl -X GET "https://onecloud.setera.com/api/queue/statistics/setera.com/aki.houlman" -H "accept: application/json" -H "Authorization: Bearer 970.VDpkYjAIn0T5kliNzcxOWU0"
ATTENZIONE: Il comando cURL generato da Swagger presenta come indirizzo www.setera.com questo dovrà essere sostituito con onecloud.setera.com per il corretto funzionamento.
- Risposta di esempio
{ "queue-statistics": { "queue": [{ "@domain": "setera.com", "@id": "5732", "@name": "Support/Orders/Billing", "@number": "+358201500800", "answeredCallsForPeriod": "10", "answeredCallsLast24h": "20", "availableAgents": "1", "averageWait": "0", "droppedCallsForPeriod": "0", "droppedCallsLast24h": "1", "lastWait": "2", "loggedInAgents": "4", "longestWaiting": "0", "current-agent-presence": { "activity": { "@count": "5", "@name": "Available" } }, "queueLength": "0", "totalCallsForPeriod": "10", "totalCallsLast24h": "20" }] }}