Per: Amministratori
Comprendere cosa può fare l'API
Scopri quali funzioni possono svolgere un tasto di gestione e un tasto hub, perché ogni tasto funge da Assistente Virtuale e dove trovare l'elenco tecnico completo.
In questo articolo2 sezioni
L’API permette al proprio software, come ad esempio un sistema di gestione dei casi, di funzionare in modo compatibile con il proprio hub, senza che nessuno debba utilizzare gli schermi per l’interazione con il sistema. Chiave APIChiave Un token segreto, creato nella sezione Integrazione, che consente al tuo software di utilizzare l'API dell'hub., Esistono due tipi di chiavi: una chiave per gestire le operazioni del pannello amministrativo, come i casi e le persone coinvolte; un’altra chiave invece serve per gestire le operazioni all’interno dei singoli casi.
Come funziona
Due chiavi, due API. Ogni tipo di chiave richiede un proprio indirizzo, seguito dall’ID del proprio hub. Tuttavia, queste chiavi vengono rifiutate dall’altro dispositivo.
| Chiave | Indirizzo | Ciò che raggiunge |
|---|---|---|
| Gestire le informazioni chiave | https://prd-api-manage.caseactive.com/v1/<hub id>/ | I casi, le persone coinvolte, i loro accessi, i ruoli, le fasi del processo, le fatture da leggere… Le importazioni sono state effettuate. https://prd-api-manage.caseactive.com/v1/integration/<hub id>/. |
| Tasto per accedere al sistema | https://prd-api-app.caseactive.com/v1/<hub id>/ | Tutto ciò che è presente all’interno di ogni caso: post e commenti, file, moduli, firme elettroniche, compiti da svolgere, fatture, eventi, note e i dettagli del caso stesso. |
Che cosa può fare una chiave di controllo… Solo quelli. Qualsiasi altro tentativo di chiamare tramite l’API del pannello di amministrazione restituirà il codice 403. BotNotAllowedException.
- *Caselli:* elenco, creazione, lettura, aggiornamento e eliminazione. Vedi “Creazione e aggiornamento dei caselli, con la gestione delle chiavi di accesso”.
- Membri dei casi: elenco, aggiunta e rimozione. Vedi “Aggiungere e rimuovere i membri dei casi utilizzando una chiave di gestione”.
- Persone: elencare, aggiungere, leggere, disattivare o riattivare. Vedi “Aggiungere e aggiornare gli utenti utilizzando la chiave di gestione”.
- Ruoli e fasi: si veda la sezione “Ruoli di lettura con funzione di gestione”.
- Campi personalizzati: leggete le pagine relative ai campi dei casi e degli utenti. Vedi Come creare e aggiornare i casi, utilizzando una chiave di gestione.
- Fatture: da leggere attentamente. Si veda la sezione “Leggere le fatture con un’interfaccia di gestione”.
- Cerca. Vedi Come cercare i casi e gli utenti che possiedono una chiave di gestione.
- Importazioni. Vedi “Eseguire un’importazione utilizzando la chiave ‘manage’”.
Ogni “chiave” rappresenta il proprio Assistente Virtuale. Segni chiave legati al tuo hub… Assistente virtualAssistente virtuale Un membro automatizzato del team che pubblica messaggi di benvenuto, check-in e post di aggiornamento per l'azienda; i suoi post sono contrassegnati da un badge di Assistente Virtuale.. Quello che viene pubblicato sotto il nome e il badge dell’Assistente Virtuale è effettivamente ciò che l’Assistente Virtuale fa. L’Assistente Virtuale è presente in ogni caso, quindi una chiave di accesso può essere utilizzata per accedere a tutti i casi presenti nel proprio hub. L’Assistente Virtuale può svolgere le funzioni previste dal suo ruolo; di default, queste funzioni sono disponibili anche per il personale che lavora direttamente con l’Assistente Virtuale. I casi chiusi, invece, sono accessibili soltanto in modalità lettura. Una chiave di accesso non può creare nuovi casi, aggiungere o rimuovere persone, pagare fatture, né aprire o rispondere a domande.
Le chiavi non scadono nel tempo. Si tratta di elementi importanti che devono rimanere attivi fino a quando un amministratore non li disattiva o li elimina. È necessario limitare il numero di questi elementi all’indirizzo IPv4 pubblico del proprio sistema. Vedi… Restringere o revocare una chiave API.
Le pagine tecniche. Ogni API pubblica un elenco tecnico completo delle sue operazioni, senza la necessità di effettuare alcun tipo di autenticazione.
| Gestisci le chiavi | Chiave Hub | |
|---|---|---|
| Interattivo (Swagger UI) | https://prd-api-manage.caseactive.com/ | https://prd-api-app.caseactive.com/ |
| Riferimento/Documentazione (ReDoc) | https://prd-api-manage.caseactive.com/redoc | https://prd-api-app.caseactive.com/redoc |
| Documento OpenAPI | https://prd-api-manage.caseactive.com/openapi.json | https://prd-api-app.caseactive.com/openapi.json |
L’elenco mostra tutti i messaggi che le app stesse inviano, compresi molti messaggi che una chiave di autorizzazione non è in grado di gestire. L’elenco sopra riportato indica quali messaggi possono essere gestiti con una chiave di autorizzazione. Per provare a gestire un messaggio sulla pagina interattiva, selezionare Autorizzare e incollare la propria chiave di autorizzazione.
Un hub chiuso. Mentre il pannello di amministrazione del tuo hub è bloccato dopo un pagamento fallito, viene rifiutata l’operazione di gestione della chiave, con il messaggio 403. ManageBillingInactiveException. La chiave “hub” continua ad essere utilizzabile fino a quando il portale diventa di tipo “leggero”. Questo avviene dopo 14 giorni dal fallimento del pagamento, se il pagamento non è ancora stato effettuato; oppure, nel caso in cui l’abbonamento annullato terminasse in quel momento. A partire da quel momento, la chiave “hub” può ancora essere utilizzata per leggere i dati del portale, ma ogni modifica apportata viene rifiutata, con il messaggio 403. BillingReadOnlyException, Fino a quando l’amministratore non riavvia la sottoscrizione.
Quando usarlo
È possibile utilizzare una chiave di gestione per far sì che il proprio sistema rimanga aggiornato rispetto ad un altro sistema: è possibile creare casi, aggiungere clienti e inserirli nei relativi casi. È anche possibile negare l’accesso a determinate persone quando queste se ne vanno, oppure caricare più dati da un file in un’unica volta. È inoltre possibile utilizzare una chiave per lavorare all’interno dei casi, grazie al proprio software: ad esempio, è possibile aggiungere informazioni quando si verificano cambiamenti nel sistema.
Per essere informato delle modifiche che avvengono nel proprio hub, piuttosto che dover chiedere tali informazioni direttamente, è possibile utilizzare un webhook. Per ulteriori informazioni, vedere Configurazione del webhook. Per creare una chiave, vedere Creazione di una chiave API.