Yapla ti consente di ottenere e modificare dati sempre più vari grazie alla sua API GraphQL.
Prerequisito: Autenticazione
Per utilizzare l'API, è necessario ottenere prima un token di accesso (access token) tramite il protocollo OAuth2. Questo articolo spiega la procedura per ottenerlo.
Puoi quindi utilizzare l'endpoint dell'API, che varia in base alla tua regione:
- America del Nord:
https://s1.yapla.com/graphql - Europa:
https://s2.yapla.com/graphql
Introspezione / Visualizzare i campi radice
GraphQL è basato su schemi, il che consente di comprendere a colpo d'occhio tutte le funzionalità di un'API.
Utilizzando la tua piattaforma di test API (ad esempio: Postman, HTTPie, ecc.), esegui un'introspezione per esplorare lo schema del server e conoscere i campi radice disponibili.
Il server ti fornirà quindi l'elenco dei campi radice dai quali potrai recuperare o manipolare i dati. In GraphQL, questi sono i punti di ingresso dell'API.
Operazioni possibili
Yapla mette a disposizione campi per due tipi di operazioni:
- Query – Recupera dati dal server. Una query specifica le informazioni richieste per il campo indicato e può includere argomenti per precisare il recupero dei dati.
- Mutation – Manipola i dati sul server (creazione, modifica, eliminazione). Una mutation specifica i dati da restituire dopo l'operazione e può anche includere argomenti per dettagliare l'operazione.
Nota: In GraphQL, il server restituisce o modifica solo i dati richiesti nella query, evitando di recuperare troppe o troppo poche informazioni.
Per ulteriori informazioni sul funzionamento di GraphQL, è possibile consultare la documentazione relativa alle specifiche GraphQL.
Campi pubblici e privati
Tra i campi radice, non tutti hanno lo stesso livello di accesso:
-
Campi pubblici: accessibili senza autenticazione o autorizzazione specifica. Utilizzati per dati o operazioni che non comportano rischi per la sicurezza (es. visualizzazione di informazioni generali).
-
Campi privati: protetti da un meccanismo di autenticazione e/o autorizzazione. Utilizzati per manipolare o consultare dati sensibili o per eseguire azioni riservate a determinati ruoli.