Importante: Il supporto dell'API JSON 2.0 verrà interrotto il 30 settembre 2024. Per assicurare un funzionamento continuo, aggiorna le applicazioni che utilizzano l'API JSON 2.0 alla versione più recente dell'API. Per la versione più recente, utilizza i link nella barra di navigazione a sinistra.
Questo documento spiega come iniziare a utilizzare l'API JSON di Blogger.
Sommario
Introduzione
Questo documento è rivolto agli sviluppatori che vogliono scrivere applicazioni che possono interagire con l'API JSON di Blogger.
L'API JSON di Blogger estende la versione 2.0 dell'API di dati di Blogger. Se vuoi recuperare i dati da Blogger in formato JSON anziché XML, utilizza l'API JSON di Blogger. Se vuoi recuperare i dati in formato XML, utilizza l'API Blogger Data.
Questa versione dell'API JSON di Blogger è attualmente di sola lettura, ma prevediamo di aggiungere funzionalità di lettura/scrittura e altre funzionalità. Non esitare a richiedere altre funzionalità nel forum di assistenza di Blogger.
Prima di iniziare
Come procurarsi 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, non devi fare altro. Puoi visitare l'interfaccia utente di Blogger per configurare, modificare o visualizzare i dati di test.
Acquisisci dimestichezza con Blogger
Se non hai familiarità con i concetti di Blogger, leggi questo documento e sperimenta l'interfaccia utente prima di iniziare a scrivere codice. Questo documento presuppone che tu abbia dimestichezza con Blogger, con i concetti di programmazione web e con i formati dei dati web.
Scopri di più sulle richieste di autorizzazione 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 tali 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.
Sfondo dell'API JSON di Blogger
Concetti di Blogger
Blogger si basa su cinque concetti di base:
- Blog: il concetto principale dell'API. Un blog contiene post e pagine. Si tratta del contenitore per i metadati del blog, come il nome e la descrizione del blog.
- Post: un post del blog è l'elemento pubblicabile creato dall'autore del blog. Queste informazioni sono tempestive e riflettono ciò che gli autori vogliono pubblicare al momento. È noto che, con il passare del tempo, i contenuti dei post del blog invecchiano e diventano meno pertinenti.
- Commenti: un commento è il luogo in cui persone diverse dall'autore del post del blog reagiscono a ciò che ha scritto l'autore. Di tutto, dai mattoni ai bouquet.
- Pagine: una pagina è un luogo per contenuti statici, come 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 agisce 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 JSON di Blogger
Una risorsa è una singola entità di 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 è un elemento secondario di una risorsa Blog.
- Risorsa Commenti: rappresenta un commento su un post specifico. Ogni risorsa Commenti è un elemento secondario di una risorsa Post.
- Risorsa Pagine: rappresenta una pagina statica. Ogni risorsa Pagine è una risorsa secondaria di una risorsa Blog.
- Risorsa Utenti: rappresenta un utente non anonimo. Viene utilizzato per identificare l'autore di una pagina, di un post o di un commento.
Il modello di dati dell'API JSON di Blogger si basa su gruppi di risorse, chiamate raccolte:
- Raccolta di blog
- Una raccolta <span="apicollection">Blogs è 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 è composta 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 risorsa post specifica.
- Raccolta Pagine
- Una raccolta di pagine è composta da tutte le risorse di pagine all'interno di una risorsa di blog specifica.
- Raccolta Utenti
- Una raccolta di utenti è composta da tutte le
risorse per gli utenti su Blogger e pertanto non può essere elencata. Un utente può recuperare la propria risorsa Utente
(ma non quella di nessun altro) tramite l'ID o utilizzando l'identificatore
self.
Operazioni dell'API JSON di Blogger
Puoi invocare due metodi diversi su raccolte e risorse nell'API JSON di Blogger, come descritto nella tabella seguente.
| Operazione | Descrizione | Mappature HTTP REST |
|---|---|---|
| list | Elenca tutte le risorse all'interno di una raccolta. | GET in un URI raccolta. |
| get | Recupera una risorsa specifica. | GET in un URI della 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 | |
| Blog | sì | sì |
| Post | sì | sì |
| Commenti | sì | sì |
| Pagine | sì | sì |
| Utenti | no | sì |
Stili di chiamata
Esistono diversi modi per richiamare l'API:
- Utilizzo di REST direttamente o da JavaScript (non è richiesto codice lato server)
- Utilizzo delle 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.
Potresti trovare utili le definizioni dei metodi nella documentazione degli standard HTTP 1.1; includono le specifiche per GET, POST, PUT e DELETE.
REST nell'API JSON di Blogger
Le operazioni di Blogger supportate mappano direttamente ai verbi HTTP REST, come descritto in Operazioni dell'API JSON di Blogger.
Il formato specifico per gli URI dell'API JSON di Blogger è:
https://www.googleapis.com/blogger/v2/users/userId https://www.googleapis.com/blogger/v2/users/self https://www.googleapis.com/blogger/v2/users/userId/blogs https://www.googleapis.com/blogger/v2/users/self/blogs https://www.googleapis.com/blogger/v2/blogs/blogId/posts https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v2/blogs/blogId/pages https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId
La spiegazione completa degli URI utilizzati e dei risultati per ogni operazione supportata nell'API è riassunta nel documento Blogger JSON API Reference.
Ecco un paio di esempi di come funziona nell'API JSON di Blogger.
Elenca i blog a cui l'utente autenticato ha diritti di accesso:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Visualizza i post del blog code.blogger.com (che ha l'ID blog 3213900):
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST da JavaScript
Puoi richiamare l'API JSON di Blogger utilizzando REST da JavaScript, con il parametro di query callback e una funzione di callback. In questo modo, puoi scrivere applicazioni avanzate che mostrano i dati di Blogger senza scrivere 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 JSON 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/v2/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 e indipendente dal linguaggio che fornisce una semplice rappresentazione di testo di strutture di dati arbitrarie. Per ulteriori informazioni, visita il sito json.org.