API JSON di Blogger: utilizzo dell'API

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 descrive come utilizzare le funzionalità comuni dell'API JSON di Blogger usando lo stile di chiamata RESTful.

Sommario

Introduzione

Questo documento è destinato agli sviluppatori che desiderano scrivere applicazioni in grado di interagire con l'API JSON di Blogger. Blogger è uno strumento per la creazione di siti web che consentono agli utenti di pubblicare le loro opinioni su base continua.

Se non hai dimestichezza con i concetti di Blogger, ti consigliamo di leggere l'articolo Come iniziare prima di iniziare a programmare.

Autorizzazione delle richieste e identificazione dell'applicazione

Ogni richiesta inviata dalla tua applicazione all'API JSON di Blogger deve identificare l'applicazione per Google. Esistono due modi per identificare la tua applicazione: utilizzando un token OAuth 2.0 (che autorizza anche la richiesta) e/o la chiave API dell'applicazione. Ecco come determinare quale di queste opzioni utilizzare:

  • Se la richiesta richiede un'autorizzazione (ad esempio una richiesta di dati privati di un individuo), l'applicazione deve fornire un token OAuth 2.0 con la richiesta. L'applicazione potrebbe anche fornire la chiave API, ma non deve.
  • Se la richiesta non richiede l'autorizzazione (ad esempio una richiesta di dati pubblici), l'applicazione deve fornire la chiave API o un token OAuth 2.0 oppure entrambi, qualunque sia l'opzione più comoda per te.

Informazioni sui protocolli di autorizzazione

La tua applicazione deve utilizzare OAuth 2.0 per autorizzare le richieste. Non sono supportati altri protocolli di autorizzazione.

Nota: l'API JSON di Blogger al momento non supporta l'accesso contemporaneamente alla richiesta dell'accesso ai dati (ibrido) o della delega dell'autorità a livello di dominio (2LO).

Autorizzazione delle richieste con OAuth 2.0

Le richieste all'API JSON di Blogger per dati utente non pubblici devono essere autorizzate da un utente autenticato.

I dettagli della procedura di autorizzazione, o "flusso", per OAuth 2.0 variano in base al tipo di applicazione che stai scrivendo. La seguente procedura generale si applica a tutti i tipi di applicazione:

  1. Quando crei la tua applicazione, la registri su Google. Google fornisce quindi le informazioni che ti saranno necessarie in un secondo momento, ad esempio un ID client e un client secret.
  2. Attiva l'API JSON di Blogger nel riquadro Servizi della console delle API di Google. Se non è elencato nella Console, salta questo passaggio.
  3. Quando la tua applicazione ha bisogno di accedere ai dati utente, chiede a Google un particolare ambito di accesso.
  4. Google mostra all'utente una finestra di dialogo OAuth, in cui chiede di autorizzare l'applicazione a richiedere alcuni dei suoi dati.
  5. Se l'utente approva, Google fornisce alla tua applicazione un token di accesso di breve durata.
  6. L'applicazione richiede i dati utente, allegando il token di accesso alla richiesta.
  7. Se Google stabilisce che la richiesta e il token sono validi, restituisce i dati richiesti.

Alcuni flussi includono passaggi aggiuntivi, come l'utilizzo di token di aggiornamento per acquisire nuovi token di accesso. Per informazioni dettagliate sui flussi per vari tipi di applicazioni, consulta la documentazione relativa al protocollo OAuth 2.0 di Google.

Ecco le informazioni sull'ambito OAuth 2.0 per l'API JSON di Blogger:

https://www.googleapis.com/auth/blogger

Per richiedere l'accesso utilizzando OAuth 2.0, la tua applicazione richiede le informazioni sull'ambito e le informazioni fornite da Google durante la registrazione dell'applicazione (ad esempio l'ID client e/o il client secret).

Suggerimento: le librerie client delle API di Google possono gestire parte del processo di autorizzazione per te. Sono disponibili per una vasta gamma di linguaggi di programmazione; consulta la pagina Librerie ed esempi per ulteriori dettagli.

Acquisizione e utilizzo di una chiave API

Le richieste all'API Blogger JSON per dati pubblici devono essere accompagnate da un identificatore, che può essere una chiave API o un token di autenticazione.

Per acquisire una chiave API, visita la console API. Nel riquadro Servizi, attiva [api_name]. Se vengono visualizzati i Termini di servizio, leggili e accettali.

Quindi, vai al riquadro Accesso API. La chiave API si trova nella parte inferiore del riquadro, nella sezione intitolata "Accesso semplice all'API".

Dopo che hai ottenuto una chiave API, l'applicazione può aggiungere il parametro di query key=yourAPIKey a tutti gli URL delle richieste.

La chiave API è sicura per l'incorporamento negli URL, non richiede alcuna codifica.

Integrazione con i blog

Recupero di un blog

Puoi recuperare le informazioni per una determinata risorsa del blog inviando una richiesta HTTP GET all'URI del blog. L'URI di una risorsa Blog ha il seguente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId

Richiesta

Ecco un esempio:

GET https://www.googleapis.com/blogger/v2/blogs/2399953&key=YOUR-API-KEY

Poiché un utente non deve essere autenticato per recuperare un blog pubblico, non è necessario fornire l'intestazione HTTP Authorization con questa richiesta GET; tuttavia, se non fornisci l'intestazione, devi fornire una chiave API.

Blogger ha anche blog privati, che richiedono autenticazione.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e i dati del blog:

200 OK

{
  "kind": "blogger#blog",
  "id": "2399953",
  "name": "Blogger Buzz",
  "description": "The Official Buzz from Blogger at Google",
  "published": "2007-04-23T22:17:29.261Z",
  "updated": "2011-08-02T06:01:15.941Z",
  "url": "http://buzz.blogger.com/",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953",
  "posts": {
    "totalItems": 494,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts"
  },
  "pages": {
    "totalItems": 2,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/pages"
  },
  "locale": {
    "language": "en",
    "country": "",
    "variant": ""
  }
}

Recupero dei blog di un utente

Puoi recuperare un elenco dei blog di un utente inviando una richiesta GET HTTP all'URI Raccolta blog:

https://www.googleapis.com/blogger/v2/users/userId/blogs

Richiesta

Ecco un esempio di richiesta GET che elenca i blog di un utente:

GET https://www.googleapis.com/blogger/v2/users/self/blogs
Authorization: /* OAuth 2.0 token here */

Nota: l'utente deve essere autenticato per elencare i suoi blog, quindi devi fornire l'intestazione HTTP Authorization con la richiesta GET.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e la rappresentazione completa dell'elenco dei blog dell'utente:

200 OK

{
  "kind": "blogger#blogList",
  "items": [
    {
      "kind": "blogger#blog",
      "id": "4967929378133675647",
      "name": "Brett's Test Blawg",
      "description": "",
      "published": "2010-10-06T23:33:31.662Z",
      "updated": "2011-08-08T06:50:02.005Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647",
      "posts": {
        "totalItems": 13,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/posts"
      },
      "pages": {
        "totalItems": 1,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages"
      },
      "locale": {
        "language": "en",
        "country": "",
        "variant": ""
      }
    }
  ]
}

Lavorare con i post

Recupero di post da un blog

Puoi recuperare un elenco di post di un determinato blog inviando una richiesta GET all'URI della raccolta di post. L'URI di una raccolta di post ha il seguente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts

Richiesta

Ecco un esempio:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts&key=YOUR-API-KEY

Poiché un utente non deve essere autenticato per recuperare i post da un blog pubblico, non è necessario fornire l'intestazione HTTP Authorization con questa richiesta GET; tuttavia, se non fornisci l'intestazione, dovrai fornire una chiave API.

Blogger ha anche blog privati, che richiedono autenticazione.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e l'elenco di post:

200 OK

{
  "kind": "blogger#postList",
  "nextPageToken": "CgkIChiAkceVjiYQ0b2SAQ",
  "prevPageToken": "CgkIChDBwrK3mCYQ0b2SAQ",
  "items": [
    {
      "kind": "blogger#post",
      "id": "7706273476706534553",
      "blog": {
        "id": "2399953"
      },
      "published": "2011-08-01T19:58:00.000Z",
      "updated": "2011-08-01T19:58:51.947Z",
      "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
      "title": "Latest updates, August 1st",
      "content": "elided for readability",
      "author": {
        "id": "401465483996",
        "displayName": "Brett Wiltshire",
        "url": "http://www.blogger.com/profile/01430672582309320414",
        "image": {
          "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
         }
      },
      "replies": {
        "totalItems": "0",
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
      }
    },
    {
      "kind": "blogger#post",
      "id": "6069922188027612413",
      elided for readability
    }
  ]
}

Recupero di un post specifico

Puoi recuperare un post specifico da un blog inviando una richiesta GET all'URI della risorsa Post. L'URI di una risorsa Post ha il seguente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId

Richiesta

Ecco un esempio:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553&key=YOUR-API-KEY

Poiché un utente non deve essere autenticato per recuperare i post da un blog pubblico, non è necessario fornire l'intestazione HTTP Authorization con questa richiesta GET; tuttavia, se non fornisci l'intestazione, dovrai fornire una chiave API.

Blogger ha anche blog privati, che richiedono autenticazione.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e i contenuti del post:

200 OK

{
  "kind": "blogger#post",
  "id": "7706273476706534553",
  "blog": {
    "id": "2399953"
  },
  "published": "2011-08-01T19:58:00.000Z",
  "updated": "2011-08-01T19:58:51.947Z",
  "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
  "title": "Latest updates, August 1st",
  "content": "elided for readability",
  "author": {
    "id": "401465483996",
    "displayName": "Brett Wiltshire",
    "url": "http://www.blogger.com/profile/01430672582309320414",
    "image": {
      "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
    }
  },
  "replies": {
    "totalItems": "0",
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
  }
}

Utilizzare i commenti

Recuperare i commenti su un post

Puoi recuperare un elenco di commenti per un post inviando una richiesta GET all'URI di raccolta dei commenti. L'URI di una raccolta di commenti ha il seguente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments

Richiesta

Ecco un esempio:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments&key=YOUR-API-KEY

Poiché un utente non deve essere autenticato per recuperare i commenti da un blog pubblico, non è necessario fornire l'intestazione HTTP Authorization con questa richiesta GET; tuttavia, se non fornisci l'intestazione, dovrai fornire una chiave API.

Blogger ha anche blog privati, che richiedono autenticazione.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e l'elenco di commenti:

200 OK

{
  "kind": "blogger#commentList",
  "nextPageToken": "CgkIFBDwjvDXlyYQ0b2SARj9mZe9n8KsnlQ",
  "prevPageToken": "CgkIFBisvMGRlyYQ0b2SARj9mZe9n8KsnlQ",
  "items": [
    {
       "kind": "blogger#comment",
       "id": "9200761938824362519",
       "post": {
         "id": "6069922188027612413"
       },
       "blog": {
         "id": "2399953"
       },
       "published": "2011-07-28T19:19:57.740Z",
       "updated": "2011-07-28T21:29:42.015Z",
       "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
       "content": "elided",
       "author": {
         "id": "530579030283",
         "displayName": "elided",
         "url": "elided",
         "image": {
           "url": "elided"
         }
       }
    },
    {
      "kind": "blogger#comment",
      "id": "400101178920857170",
      elided for readability
    }
  ]
}

Recupero di un commento specifico

Puoi recuperare un commento specifico da un post inviando una richiesta GET all'URI della risorsa dei commenti. L'URI di una risorsa commenti ha il seguente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId

Richiesta

Ecco un esempio:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519&key=YOUR-API-KEY

Poiché un utente non deve essere autenticato per recuperare i commenti da un blog pubblico, non è necessario fornire l'intestazione HTTP Authorization con questa richiesta GET; tuttavia, se non fornisci l'intestazione, dovrai fornire una chiave API.

Blogger ha anche blog privati, che richiedono autenticazione.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e i dati del commento:

200 OK

{
  "kind": "blogger#comment",
  "id": "9200761938824362519",
  "post": {
    "id": "6069922188027612413"
  },
  "blog": {
    "id": "2399953"
  },
  "published": "2011-07-28T19:19:57.740Z",
  "updated": "2011-07-28T21:29:42.015Z",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
  "content": "elided",
  "author": {
    "id": "530579030283",
    "displayName": "elided",
    "url": "elided",
    "image": {
      "url": "elided"
    }
  }
}

Utilizzo delle pagine

Recupero di pagine per un blog

Puoi recuperare un elenco di pagine relative a un blog inviando una richiesta GET all'URI Raccolta di pagine. L'URI di una raccolta di pagine ha il seguente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages

Richiesta

Ecco un esempio:

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages&key=YOUR-API-KEY

Poiché un utente non deve essere autenticato per recuperare le Pagine da un blog pubblico, non è necessario fornire l'intestazione HTTP Authorization con questa richiesta GET; tuttavia, se non fornisci l'intestazione, dovrai fornire una chiave API.

Blogger ha anche blog privati, che richiedono autenticazione.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e l'elenco di pagine:

200 OK

{
  "kind": "blogger#pageList",
  "items": [
    {
      "kind": "blogger#page",
      "id": "273541696466681878",
      "blog": {
        "id": "4967929378133675647"
      },
      "published": "2011-07-14T16:16:00.000Z",
      "updated": "2011-07-14T16:16:23.602Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
      "title": "Static Content",
      "content": "elided for readability",
      "author": {
        "id": "901569848744",
        "displayName": "brett",
        "url": "http://www.blogger.com/profile/16258312240222542576",
        "image": {
          "url": "https://resources.blogblog.com/img/b16-rounded.gif"
        }
      }
    }
  ]
}

Recupero di una pagina specifica

Puoi recuperare una pagina specifica da un blog inviando una richiesta GET all'URI della risorsa Pagine. L'URI di una risorsa Pages (Pagine) ha il formato seguente:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId

Richiesta

Ecco un esempio:

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878&key=YOUR-API-KEY

Poiché un utente non deve essere autenticato per recuperare le Pagine da un blog pubblico, non è necessario fornire l'intestazione HTTP Authorization con questa richiesta GET; tuttavia, se non fornisci l'intestazione, dovrai fornire una chiave API.

Blogger ha anche blog privati, che richiedono autenticazione.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e i dati della pagina:

200 OK

{
  "kind": "blogger#page",
  "id": "273541696466681878",
  "blog": {
    "id": "4967929378133675647"
  },
  "published": "2011-07-14T16:16:00.000Z",
  "updated": "2011-07-14T16:16:23.602Z",
  "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
  "title": "Static Content",
  "content": "elided for readability",
  "author": {
    "id": "901569848744",
    "displayName": "brett",
    "url": "http://www.blogger.com/profile/16258312240222542576",
    "image": {
      "url": "https://resources.blogblog.com/img/b16-rounded.gif"
    }
  }
}

Gestione degli utenti

Recupero di un utente

Puoi recuperare le informazioni di un utente inviando una richiesta GET HTTP all'URI risorsa dell'utente:

https://www.googleapis.com/blogger/v2/users/userId

Richiesta

Ecco un esempio di richiesta GET che elenca i blog di un utente:

GET https://www.googleapis.com/blogger/v2/users/self
Authorization: /* OAuth 2.0 token here */

Nota: per poter elencare le proprie informazioni, l'utente deve essere autenticato, quindi devi fornire l'intestazione HTTP Authorization con la richiesta GET.

Risposta

Se la richiesta ha esito positivo, il server risponde con un codice di stato HTTP 200 OK e un link a un elenco dei blog dell'utente:

200 OK

{
  "kind": "blogger#user",
  "id": "901569848744",
  "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744",
  "blogs": {
    "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744/blogs"
  }
}

Parametri di query standard

I seguenti parametri di query possono essere utilizzati con tutti i metodi e tutte le risorse delle API Blogger.

I parametri di query che si applicano a tutte le operazioni dell'API Blogger sono illustrati nella sezione Parametri di sistema.