Questo documento spiega come iniziare a utilizzare l'API Blogger.
Prima di iniziare
Crea un Account Google
Assicurati di aver configurato un Account Google. Ti consigliamo di utilizzare un Account Google separato per scopi di sviluppo e test per proteggerti dalla perdita accidentale di dati. Se hai già un account di test, puoi visitare l'interfaccia utente di Blogger per configurare, modificare o visualizzare i dati di test.
Acquisire dimestichezza con Blogger
Se non hai familiarità con i concetti di Blogger, leggi questo documento e sperimenta con l'interfaccia utente prima di iniziare a programmare. Questo documento presuppone che tu abbia familiarità con Blogger, con i concetti di programmazione web e con i formati dei dati web.
Scopri di più sull'autorizzazione delle richieste e sull'identificazione della tua applicazione
Quando la tua applicazione richiede dati privati, la richiesta deve essere autorizzata da un utente autenticato che ha accesso a questi dati.
Quando la tua applicazione richiede dati pubblici, la richiesta non deve essere autorizzata, ma deve essere accompagnata da un identificatore, ad esempio una chiave API.
Per informazioni su come autorizzare le richieste e utilizzare le chiavi API, consulta la sezione Autorizzazione delle richieste e identificazione dell'applicazione nel documento Utilizzo dell'API.
Informazioni di base sull'API di Blogger
Concetti di Blogger
Blogger si basa su cinque concetti fondamentali:
- Blog: il concetto principale dell'API. Un blog ha post e pagine. Questo è il contenitore per i metadati del blog, come il nome e la descrizione.
- Post: un post del blog è l'elemento pubblicabile creato dall'autore del blog. Queste informazioni devono essere tempestive e riflettere ciò che gli autori vogliono pubblicare per il mondo in questo momento. È risaputo che con il passare del tempo i contenuti dei post del blog invecchiano e diventano meno pertinenti.
- Commenti: un commento è il luogo in cui le persone diverse dall'autore del post del blog reagiscono a ciò che ha scritto. Di tutto, dai mattoni ai bouquet.
- Pagine: una pagina è uno spazio per contenuti statici, ad esempio informazioni biografiche o i modi per contattare l'utente. Si tratta in genere di informazioni senza tempo che non cambiano molto spesso.
- Utenti: un utente è una persona che interagisce con Blogger, che agisca come autore, amministratore o semplice lettore. Per i blog pubblici, i lettori possono essere anonimi, ma sui blog privati un lettore deve essere identificato da Blogger.
Modello di dati dell'API Blogger
Una risorsa è una singola entità di dati con un identificatore univoco. L'API Blogger JSON opera su cinque tipi di risorse:
- Risorsa Blog: rappresenta un blog.
- Risorsa Post: rappresenta un post; ogni risorsa post è una risorsa secondaria di una risorsa blog.
- Risorsa Comments: rappresenta un commento su un post specifico; ogni risorsa Comments è una risorsa secondaria di una risorsa Posts.
- Risorsa Pagine: rappresenta una pagina statica; ogni risorsa pagine è una risorsa secondaria di una risorsa blog.
- Risorsa Users: rappresenta un utente non anonimo. Questo valore viene utilizzato per identificare l'autore di una pagina, di un post o di un commento.
Il modello di dati dell'API Blogger si basa su gruppi di risorse, chiamati raccolte:
- Raccolta di blog
- Una raccolta di blog è costituita da tutti i blog a cui un utente ha diritti di accesso. Puoi elencare i blog per utente o recuperare un singolo blog per ID.</span="apicollection">
- Raccolta di post
- Una raccolta di post è costituita da tutte le risorse di post all'interno di una risorsa di blog specifica.
- Raccolta di commenti
- Una raccolta di commenti è costituita da tutte le risorse di commenti all'interno di una specifica risorsa di post.
- Raccolta Pagine
- Una raccolta di pagine è costituita da tutte le risorse di pagine all'interno di una specifica risorsa di blog.
- Raccolta Utenti
- Una raccolta di utenti è costituita da tutte le
risorse utente su Blogger e pertanto non può
essere elencata. Un utente può recuperare la propria risorsa utenti
(ma non quella di altri) per ID o utilizzando l'identificatore
self.
Operazioni dell'API Blogger
Puoi richiamare diversi metodi su raccolte e risorse nell'API Blogger, come descritto nella tabella seguente.
| Operazione | Descrizione | Mapping HTTP REST |
|---|---|---|
| list | Elenca tutte le risorse all'interno di una raccolta. | GET su un URI di raccolta. |
| get | Recupera una risorsa specifica. | GET su un URI risorsa. |
| getByUrl | Recupera una risorsa cercandola per URL. | GET con l'URL passato come parametro. |
| getByPath | Recupera una risorsa cercandola in base al percorso. | GET con il percorso passato come parametro. |
| listByUser | Elenca le risorse di proprietà di un utente. | GET in una raccolta di proprietà dell'utente. |
| search | Cerca risorse in base a un parametro di query. | GET in un URL di ricerca, con la query trasmessa come parametro. |
| insert | Creare una risorsa in una raccolta. | POST su un URI di raccolta. |
| elimina | Elimina una risorsa. | DELETE su un URI risorsa. |
| patch | Aggiorna una risorsa utilizzando la semantica della patch. | PATCH su un URI risorsa. |
| aggiornamento | Aggiorna una risorsa. | PUT su un URI risorsa. |
La tabella seguente mostra i metodi supportati da ciascun tipo di risorsa. Tutte le operazioni list e get sui blog privati richiedono l'autenticazione.
Tipo di risorsa |
Metodi supportati |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| list | get | getByUrl | getByPath | listByUser | search | insert | delete | patch | update | |
| Blog | no | sì | sì | no | sì | no | no | no | no | no |
| Post | sì | sì | no | sì | no | sì | sì | sì | sì | sì |
| Commenti | sì | sì | no | no | no | no | no | no | no | no |
| Pagine | sì | sì | no | no | no | no | no | no | no | no |
| Utenti | no | sì | no | no | no | no | no | no | no | no |
Stili di chiamata
Esistono diversi modi per richiamare l'API:
- Utilizzo di REST direttamente o da JavaScript (non è necessario codice lato server)
- Utilizzare le librerie client.
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 degli standard HTTP 1.1, in cui sono incluse le specifiche per i metodi GET, POST, PUT e DELETE.
REST nell'API Blogger
Le operazioni di Blogger supportate corrispondono direttamente ai verbi HTTP REST, come descritto in Operazioni dell'API Blogger.
Il formato specifico per gli URI dell'API Blogger è:
https://www.googleapis.com/blogger/v3/users/userId https://www.googleapis.com/blogger/v3/users/self https://www.googleapis.com/blogger/v3/users/userId/blogs https://www.googleapis.com/blogger/v3/users/self/blogs https://www.googleapis.com/blogger/v3/blogs/blogId https://www.googleapis.com/blogger/v3/blogs/byurl https://www.googleapis.com/blogger/v3/blogs/blogId/posts https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v3/blogs/blogId/pages https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId
La spiegazione completa degli URI utilizzati e dei risultati per ogni operazione supportata nell'API è riepilogata nel documento Riferimento API Blogger.
Esempi
Elenca i blog a cui l'utente autenticato ha diritti di accesso:
GET https://www.googleapis.com/blogger/v3/users/self/blogs?key=YOUR-API-KEY
Recupera i post del blog code.blogger.com con ID blog 3213900:
GET https://www.googleapis.com/blogger/v3/blogs/3213900?key=YOUR-API-KEY
REST da JavaScript
Puoi richiamare l'API Blogger da JavaScript utilizzando il
parametro di query callback e fornendo una funzione di callback.
Quando il browser carica lo script, la funzione di callback viene eseguita e la
risposta viene fornita alla funzione di callback. Questo approccio ti consente di scrivere applicazioni avanzate che mostrano i dati di Blogger senza richiedere codice lato server.
L'esempio seguente recupera un post dal blog code.blogger.com, dopo aver sostituito YOUR-API-KEY con la tua chiave API.
<html>
<head>
<title>Blogger API Example</title>
</head>
<body>
<div id="content"></div>
<script>
function handleResponse(response) {
document.getElementById("content").innerHTML += "<h1>" + response.title + "</h1>" + response.content;
}
</script>
<script
src="https://www.googleapis.com/blogger/v3/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY"></script>
</body>
</html>Formato dei dati
JSON
JSON (JavaScript Object Notation) è un formato di dati comune, indipendente dal linguaggio, che fornisce una semplice rappresentazione testuale di strutture arbitrarie di dati. Per ulteriori informazioni, visita il sito json.org.