Gli agenti AI inviano richieste HTTP da server a server al tuo sistema di backend. Le richieste vengono avviate quando un percorso utente attiva un nodo di integrazione nel dialogo e i dati restituiti mappati vengono archiviati e disponibili per la durata della sessione degli agenti AI .
Requisiti tecnici dell’API di backend
Tipi di API
L’API deve essere una delle seguenti architetture:
- RIPOSO
- GraphQL
Risposta
La risposta API deve soddisfare i requisiti generali:
- Fornisci una risposta API entro 30 secondi
- Restituisci preferibilmente il formato JSON
Autenticazione
Per quanto riguarda gli agenti AI , possiamo autenticare usando uno dei seguenti strumenti:
- Chiave API
- Token di connessione
- Token di scadenza
- Autent. base
- OAuth 2.0
- Elenchi indirizzi attendibili IP/elenco consentito
Elenco di controllo automatico
L’elenco di autocontrollo seguente contiene domande e informazioni che ti aiuteranno a creare un’API affidabile:
- L’API è “ricercabile” con i dati che un utente normale conoscerebbe o con i dati trasmessi dal tuo CRM?
- I dati nella risposta API contengono informazioni che soddisfano il tuo caso d’uso?
- Se il tuo caso d'uso richiede dati da più sistemi, puoi consolidarli in un livello intermedio?
- È noto quando l’API genera un codice di stato HTTP 200, 400 e 404?
- Cosa restituisce l’API se l’input non è valido o errato?
- Il tuo sistema imposta un limite di velocità API?
- Quanto tempo impiega il sistema a inviare una risposta?
Preparati a fornire:
• Documentazione: Auth, query/corpo della richiesta API e schema di risposta
• (Facoltativamente una collezione Postman.)
• Testare i dati per i risultati più comuni.
Per ulteriori informazioni sul piano di onboarding, consulta l’articolo precedente, Integrazione personalizzata - Preparazione .
Avvertenza sulla traduzione: questo articolo è stato tradotto usando un software di traduzione automatizzata per fornire una comprensione di base del contenuto. È stato fatto tutto il possibile per fornire una traduzione accurata, tuttavia Zendesk non garantisce l'accuratezza della traduzione.
Per qualsiasi dubbio sull'accuratezza delle informazioni contenute nell'articolo tradotto, fai riferimento alla versione inglese dell'articolo come versione ufficiale.