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 prova, è tutto pronto. Puoi visitare l'interfaccia utente di Blogger per impostare, modificare o visualizzare i tuoi dati di test.
Acquisisci familiarità 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, che abbia concetti di programmazione web e con formati di dati web.
Scopri di più sull'autorizzazione delle richieste e sull'identificazione della tua applicazione
Quando la tua applicazione richiede dati privati, questa deve essere autorizzata da un utente autenticato che ha accesso a questi dati.
Quando l'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 l'articolo su come autorizzare le richieste e identificare l'applicazione nel documento Utilizzo del documento API.
Sfondo dell'API di Blogger
Concetti di Blogger
Blogger si basa su cinque concetti di base:
- Blog: il concetto principale dell'API. Un blog include post e pagine. Questo è il contenitore per le meta-informazioni dei blog come il nome e la descrizione.
- Post: un post del blog è l'elemento pubblicabile creato dall'autore del blog. Queste informazioni sono pensate per essere tempestive, in quanto rispecchiano ciò che gli autori vogliono pubblicare nel mondo attuale. Siamo consapevoli che, con il passare del tempo, i post dei blog potrebbero invecchiare e diventare meno pertinenti.
- Commenti: un commento è il luogo in cui persone diverse dal post del blog reagiscono a ciò che l'autore ha scritto. Dai mattoni ai bouquet.
- Pagine: in una pagina sono presenti contenuti statici, ad esempio informazioni biografiche o come 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, agisce come autore, amministratore o solo come lettore. Per i blog pubblici, i lettori possono essere anonimi, ma sui blog privati devono essere identificati da Blogger.
Modello di dati dell'API di Blogger
Una risorsa è una singola entità dati con un identificatore univoco. L'API JSON di Blogger opera su cinque tipi di risorse:
- Risorsa blog: rappresenta un blog.
- Risorsa post: rappresenta un post; ogni risorsa post è secondaria rispetto a una risorsa blog.
- Risorsa commenti: rappresenta un commento su un post specifico. Ogni risorsa dei commenti è una risorsa secondaria di un post.
- Risorsa pagine: rappresenta una pagina statica; ogni risorsa pagina è figlio di una risorsa del blog.
- Risorsa utente: rappresenta un utente non anonimo. Utilizzato per identificare l'autore di una pagina, un post o un commento.
Il modello di dati dell'API di Blogger si basa su gruppi di risorse, denominate raccolte:
- Raccolta di blog
- Una raccolta <span/#quot;apicollection">blog è composta da tutti i blog a cui un utente ha diritti di accesso. Puoi elencare i blog per utente o recuperare un singolo blog in base all'ID.</span/#quot;apicollection">
- Raccolta di post
- Una raccolta di post è composta da tutte le risorse relative ai post di una specifica risorsa di blog.
- Raccolta commenti
- Una raccolta di commenti è composta da tutte le risorse relative ai commenti all'interno di una specifica risorsa.
- Raccolta di pagine
- Una raccolta di pagine è composta da tutte le risorse di pagine all'interno di una specifica risorsa del blog.
- Raccolta utenti
- Una raccolta di utenti è composta da tutte le risorse utente su Blogger e non può quindi essere elencata. Un utente può recuperare la propria risorsa degli utenti (ma nessun altro utente) per ID o utilizzando l'identificatore
self.
Operazioni dell'API di Blogger
Puoi richiamare diversi metodi su raccolte e risorse nell'API Blogger, come descritto nella tabella seguente.
| Operazione | Descrizione | Mappature HTTP REST |
|---|---|---|
| list | Elenca tutte le risorse all'interno di una raccolta. | GET su un URI della raccolta. |
| get | Visualizza una risorsa specifica. | GET su un URI della risorsa. |
| getByUrl | Recupera una risorsa, cercandola tramite URL. | GET con l'URL trasmesso come parametro. |
| getByPath | Recupera una risorsa cercandola in base al percorso. | GET con il percorso trasmesso come parametro. |
| listByUser | Elenca le risorse di proprietà di un utente. | GET in una raccolta di proprietà dell'utente. |
| search | Cerca le risorse in base a un parametro di ricerca. | GET su un URL della Ricerca, con la query trasferita come parametro. |
| Inserisci | Creare una risorsa in una raccolta. | POST su un URI della raccolta. |
| elimina | Elimina una risorsa. | DELETE su un URI della risorsa. |
| patch | Aggiornare una risorsa utilizzando la semantica delle patch. | PATCH su un URI della risorsa. |
| aggiorna | Aggiornare una risorsa. | PUT su un URI della risorsa. |
La tabella seguente mostra i metodi supportati per ogni tipo di risorsa. Tutte le operazioni di elenco e get su blog privati richiedono l'autenticazione.
Tipo di risorsa |
Metodi supportati |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| lista | get. | getByUrl | getByPath | listByUser | ricerca | inserire | elimina | patch | aggiorna | |
| 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 utilizzando un verbo HTTP come POST, GET, PUT o DELETE. Specifica una risorsa tramite un URI univoco a livello globale del 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 GET, POST, PUT e DELETE.
REST nell'API di Blogger
Le operazioni di Blogger supportate vengono mappate direttamente ai verbi HTTP REST, come descritto nelle operazioni dell'API Blogger.
Il formato specifico per gli URI dell'API Blogger sono:
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 i risultati di ogni operazione supportata nell'API sono riassunti nel documento Blogger API Reference.
Esempi
Elenca i blog per i quali l'utente autenticato dispone dei diritti di accesso:
GET https://www.googleapis.com/blogger/v3/users/self/blogs?key=YOUR-API-KEY
Scarica i post sul blog code.blogger.com, in cui l'ID del 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 ricerca callback e fornendo una funzione di callback.
Quando il browser carica lo script, la funzione di callback viene eseguita e la risposta viene fornita a tale funzione. 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 comune dei dati indipendente dal linguaggio che fornisce una semplice rappresentazione testuale di strutture arbitrarie di dati. Per saperne di più, consulta json.org.