Le operazioni dell'API Admin vengono mappate direttamente ai verbi HTTP REST, il che significa utilizzare i metodi HTTP standard per recuperare e manipolare le risorse.
I formati specifici per gli URI dell'API Admin sono:
https://appengine.googleapis.com/v1/resourcePath?parameters
Ad esempio, per elencare tutti i dettagli sulla versione my-v1 nel servizio my-
frontend dell'applicazione nel progetto my-app, puoi inviare la richiesta HTTP con il parametro ?view=FULL:
GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL
Consulta il documento API App Engine Admin Reference per l'insieme completo di URI utilizzati per ogni operazione supportata nell'API.
Impara le basi
Non hai mai utilizzato le API REST? Di seguito sono riportate alcune risorse utili per iniziare.
Nozioni di base su REST
Esistono due modi per richiamare l'API:
- Inviare richieste HTTP e analizzarne le risposte.
- Utilizzo delle librerie client.
Se decidi di non utilizzare le librerie client, dovrai conoscere le nozioni di base di REST.
REST è un tipo di architettura software che fornisce un approccio pratico e coerente per la richiesta e la modifica dei dati.
Il termine REST è l'acronimo di "REpresentational State Transfer". Nel contesto delle API di Google, si riferisce all'utilizzo dei verbi HTTP per recuperare e modificare le rappresentazioni dei dati archiviati da Google.
In un sistema RESTful, le risorse vengono archiviate in un datastore. Un client invia una richiesta affinché il server esegua una determinata azione (ad esempio la creazione, il recupero, l'aggiornamento o l'eliminazione di una risorsa) e il server esegue l'azione e invia una risposta, spesso sotto forma di rappresentazione della risorsa specificata.
Nelle API RESTful di Google, il client specifica un'azione mediante un verbo HTTP come POST, GET, PUT o DELETE. La risorsa viene specificata tramite un URI globalmente univoco con il seguente formato:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Poiché tutte le risorse dell'API dispongono di URI univoci accessibili tramite HTTP, REST consente la memorizzazione dei dati nella cache ed è ottimizzato per operare con l'infrastruttura distribuita del Web.
Potrebbero esserti utili le definizioni dei metodi riportate nella documentazione sugli standard HTTP 1.1. includono le specifiche per GET, POST, PUT e DELETE.
Nozioni di base su JSON
L'API Admin restituisce i dati in formato JSON.
JSON (JavaScript Object Notation) è un formato di dati comune e indipendente dal linguaggio che fornisce una semplice rappresentazione di testo di strutture di dati arbitrarie. Per ulteriori informazioni, visita il sito json.org.