Quando si effettuano richieste usando le API Sunshine Conversations, è necessaria l’autenticazione per verificare l’identità del chiamante. Per verificare l’identità di un chiamante, puoi usare l’ autenticazione base o JSON Web Token (JWT). Entrambi i metodi richiedono una chiave API. Puoi creare la chiave API usando la pagina API conversazioni.
L’accesso alla pagina API conversazioni è incluso nei Piani Zendesk Suite Professional o superiori. Per visualizzare la pagina, devi attivare lo Spazio di lavoro agente Zendesk. Sono disponibili ulteriori pacchetti di componenti aggiuntivi se desideri un numero maggiore di utenti attivi mensili (MAU) o di notifiche. Per maggiori informazioni, consulta Informazioni sui componenti aggiuntivi per Zendesk Suite.
Questo articolo include le seguenti sezioni:
Informazioni sulle chiavi API
Una chiave API identifica e autentica un'applicazione o un utente ed è composta da tre parti:
- L’ ID app identifica l’account Zendesk.
- L’ ID chiave, utilizzato insieme alla chiave segreta, corrisponde alle credenziali utilizzate per autenticare i JWT e le chiamate API.
- La chiave segreta è la password di autenticazione.
Con l’autenticazione base, effettui le richieste usando direttamente una chiave API. L’ID chiave è il nome utente e il segreto è la password.
Con i JWT, accedi ai token con una chiave API, che vengono poi usati per autenticarti con l'API. L'ID chiave è incluso nell'intestazione del JWT come proprietà kid, mentre il segreto accede al JWT.
Le chiavi API non sono sicure come i token di autenticazione. Assicurati di seguire le buone prassi per gestire in sicurezza le credenziali quando usi una chiave API in produzione.
Per ulteriori informazioni sull’autenticazione Sunshine Conversations, consulta Autenticazione API.
La chiave API Sunshine Conversations è diversa dalle chiavi di autenticazione della messaggistica. Le chiavi di autenticazione della messaggistica vengono utilizzate per accedere alle credenziali che autenticano gli utenti finali utilizzando gli SDK Zendesk. La chiave API consente di effettuare chiamate da server a server e di accedere alle API pubbliche di Sunshine Conversations che supportano l'ambito app.
Creazione e condivisione di ID e chiave API
Un amministratore Zendesk deve creare una chiave API e condividerla con lo sviluppatore. Puoi memorizzare fino a 10 chiavi.
Per creare e condividere una chiave API
-
Nel Centro amministrativo, fai clic su
App e integrazioni nella barra laterale, quindi seleziona API > API conversazioni.
Nota: per visualizzare questa finestra, devi disporre di un piano Zendesk Suite Professional o superiore. - Fai clic su Crea chiave API.
Se stai creando la tua prima chiave, questo pulsante appare nella parte inferiore della pagina; se hai già creato una chiave, questa apparirà nell’angolo in alto a destra.
- Inserisci un nome identificativo per la chiave nella finestra di dialogo Crea nuova chiave, quindi fai clic su Avanti.
- Nella finestra di dialogo Copia segreto condiviso, fai clic su Copia per ciascun ID e chiave segreta per salvarli negli appunti, quindi fai clic su Avanti.
A questo punto sarai indirizzato alla finestra API, dove la nuova chiave viene visualizzata nell'elenco.
Se generi una nuova chiave, ma hai raggiunto il limite di 10 chiavi, viene visualizzata una notifica che ti chiede di eliminare le chiavi inutilizzate.
Per eliminare una chiave inutilizzata
- Nel Centro amministrativo, fai clic su App e integrazioni nella barra laterale, quindi seleziona API > API conversazioni.
- Posiziona il puntatore del mouse sul tasto che intendi eliminare, quindi fai clic sul menu delle opzioni (
) e seleziona Elimina. - Conferma l’azione facendo clic su Elimina.