Importante: interromperemo il supporto per l'API JSON v2.0 il 30 settembre 2024. Per garantire una funzionalità continuativa, aggiorna le applicazioni che si basano sull'API JSON v2.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 è destinato agli sviluppatori che desiderano scrivere applicazioni in grado di 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 di dati di Blogger.
Questa versione dell'API Blogger JSON è attualmente in sola lettura. Tuttavia, prevediamo di aggiungere funzionalità di lettura/scrittura, oltre ad altre funzionalità. Non esitare a richiedere altre funzionalità sul Forum di assistenza di 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, al fine di proteggerti dalla perdita accidentale di dati. Se disponi già di un account di prova, è tutto a posto. Puoi accedere all'interfaccia utente di Blogger per configurare, modificare o visualizzare i dati di test.
Familiarizza con Blogger
Se non hai dimestichezza con i concetti di Blogger, leggi questo documento e sperimenta con l'interfaccia utente prima di iniziare a programmare. Questo documento presuppone la conoscenza di Blogger, con i concetti di programmazione web e i formati di dati web.
Scopri di più sull'autorizzazione delle richieste e sull'identificazione dell'applicazione
Quando l'applicazione richiede dati privati, la richiesta 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 Autorizzazione delle richieste e identificazione dell'applicazione nel documento Utilizzo dell'API.
Sfondo API Blogger JSON
Concetti di Blogger
Blogger si basa su cinque concetti di base:
- Blog: il concetto alla base dell'API. Un blog contiene post e pagine. Questo è il contenitore per le meta-informazioni dei blog, come Nome blog e Descrizione.
- Post: un post del blog è l'elemento pubblicabile creato dall'autore del blog. Queste informazioni sono state concepite per essere tempestive, per riflettere ciò che gli autori vogliono pubblicare ora per il mondo. Resta inteso che con il passare del tempo i contenuti dei 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 è un luogo in cui sono contenuti contenuti statici, ad esempio informazioni biografiche, o i modi per contattare l'utente. Di solito si tratta di informazioni senza tempo che non cambiano molto spesso.
- Utenti: un utente è una persona che interagisce con Blogger, sia che agisce come autore, amministratore o solo lettore. I lettori dei blog pubblici potrebbero essere anonimi, mentre sui blog privati i lettori devono essere identificati da Blogger.
Modello dati 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 del 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 è secondaria di una risorsa post.
- Risorsa Pagine: rappresenta una pagina statica; ogni risorsa Pagine è un elemento secondario di una risorsa Blog.
- Risorsa utenti: rappresenta un utente non anonimo. Utilizzato per identificare l'autore di una pagina, un post o un commento.
Il modello di dati dell'API JSON di Blogger si basa su gruppi di risorse, chiamati raccolte:
- Raccolta di blog
- Una <span="apicollection">raccolta blog include tutti i blog per i quali un utente dispone dei 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 specifica risorsa dei blog.
- Raccolta commenti
- Una raccolta di commenti è composta da tutte le risorse di commento all'interno di una specifica risorsa per i post.
- Raccolta di pagine
- Una raccolta di pagine è composta da tutte le risorse di Pagine all'interno di una specifica risorsa Blog.
- Raccolta utenti
- Una raccolta utenti include tutte le
risorse utente di Blogger, pertanto non può
essere elencata. Un utente può recuperare la propria risorsa utente
(ma quella di nessun altro) tramite ID o utilizzando l'identificatore
self.
Operazioni dell'API JSON di Blogger
Puoi richiamare 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 di raccolta. |
| recupero | Recupera una risorsa specifica. | GET su un URI di risorsa. |
La tabella seguente mostra quali metodi sono supportati da ciascun tipo di risorsa. Tutte le operazioni list e get sui blog privati richiedono l'autenticazione.
Tipo di risorsa |
Metodi supportati |
|
|---|---|---|
| elenco | recupera | |
| 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:
- Utilizzare REST direttamente o da JavaScript (non è richiesto 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 mediante un URI univoco globale nel formato seguente:
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, in quanto includono le specifiche per GET, POST, PUT e DELETE.
REST nell'API JSON di Blogger
Le operazioni supportate di Blogger corrispondono direttamente ai verbi HTTP REST, come descritto nelle operazioni dell'API JSON di Blogger.
I formati specifici per gli URI dell'API JSON di Blogger sono:
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 di ogni operazione supportata nell'API è riassunta nel documento Riferimento API JSON di Blogger.
Ecco un paio di esempi del funzionamento di questa operazione nell'API JSON di Blogger.
Elenca i blog per i quali l'utente autenticato dispone dei diritti di accesso:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Scarica i post sul 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 Blogger utilizzando REST da JavaScript, utilizzando il parametro di query callback e una funzione di callback. Questo ti permette di scrivere applicazioni avanzate che visualizzano 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 dati comune e indipendente dal linguaggio che fornisce una semplice rappresentazione testuale di strutture di dati arbitrarie. Per ulteriori informazioni, visita il sito json.org.