Sebbene le API REST siano da tempo uno standard per abilitare le integrazioni, GraphQL sta rapidamente guadagnando terreno grazie alla sua flessibilità ed efficienza. Puoi sfruttare le funzioni di Creazione integrazione per l’integrazione con le API GraphQL. Puoi sfruttare le funzionalità chiave di GraphQL, come richiedere solo i dati di cui hai bisogno e gestire facilmente query complesse.
In questo articolo, ti guideremo attraverso il processo di configurazione di una richiesta GraphQL usando lo strumento di creazione integrazioni, dalla comprensione dello schema GraphQL alla creazione di query e all'integrazione delle risposte nelle conversazioni.
Per impostare una richiesta GraphQL
- Trova l’URL dell’endpoint GraphQL, solitamente fornito dalla documentazione API (ad esempio, https://api.example.com/graphql o per Shopify: https://{{storeName}} .myshopify.com/admin/api/2023-04/graphql.json).
- Aggiungilo all’interfaccia di Creazione integrazioni.
- Passa ad Ambienti e seleziona il tipo di metodo POST (se stai richiedendo dati).
- Aggiungi l’endpoint GraphQL all’input URL.
- Seleziona il metodo di autenticazione (se richiesto).
- Se necessario, aggiungi le tue credenziali alle intestazioni. Ad esempio, se si tratta di un’integrazione Shopify , avrà il seguente aspetto:
- Scopri lo schema GraphQL per selezionare i dati che vuoi restituire dal server.
- Ottieni lo schema dal server GraphQL.
Definisce le query, le mutazioni e i tipi disponibili. Usa strumenti come Postman, GraphiQL o Apollo Explorer per esaminare lo schema e per testare e perfezionare la query.
Ti consigliamo di ottenere la query da Postman accedendo alla scheda Frammento di codice e controllando i dati in cui dovresti vedere un oggetto con la chiave “query”. Copia l’oggetto da usare nel passaggio successivo.
- Nella scheda Body, aggiungi la query GraphQL che specifica i dati necessari o l’azione da eseguire (se si richiede una mutazione per modificare i dati; creare, aggiornare, eliminare).
Deve essere in formato JSON.
Esempio di query:
```{"query":"{\n __type(name: \"Ordine\") {\n nome,\n campi {\n nome\n digita {\n nome\n gentile\n }\n }\n }\n}","variables":{}}```
- Passa allo scenario Operazione riuscita per aggiungere i parametri della sessione.
- Usando JSONata, scrivi le query per accedere e trasformare (se necessario) i dati nella risposta. Vedi sotto per un esempio:
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.