Wymagania wstępne

Zanim zaczniesz kodować pierwszą aplikację kliencką, musisz wykonać kilka czynności.

Załóż konto Google

Aby utworzyć projekt w Konsoli interfejsów API Google, musisz mieć konto Google. Jeśli masz już konto, nie musisz nic więcej robić.

Możesz też utworzyć osobne konto Google do celów testowych.

Tworzenie projektu dla klienta

Aby móc wysyłać żądania do interfejsu Google Knowledge Graph Search API, musisz poinformować Google o swoim kliencie i aktywować dostęp do interfejsu API. W tym celu musisz użyć konsoli interfejsów API Google, aby utworzyć projekt, czyli nazwany zbiór ustawień i informacji dostępowych interfejsu API, oraz zarejestrować swoją aplikację.

Aby rozpocząć korzystanie z interfejsu Google Knowledge Graph Search API, musisz najpierw użyć narzędzia do konfiguracji, które przeprowadzi Cię przez proces tworzenia projektu w konsoli interfejsów API Google, włączania interfejsu API i tworzenia danych logowania.

Jeśli jeszcze tego nie zrobiono, utwórz klucz interfejsu API aplikacji, klikając Utwórz dane logowania > Klucz interfejsu API. Następnie w sekcji Klucze interfejsu API odszukaj klucz interfejsu API.

Podstawy protokołu REST

Interfejs API można wywołać na 2 sposoby:

  • wysyłać żądania HTTP i analizować odpowiedzi;
  • Korzystanie z bibliotek klienta.

Jeśli zdecydujesz się nie używać bibliotek klienta, musisz poznać podstawy protokołu REST.

REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do wysyłania żądań i modyfikowania danych.

Termin REST to skrót od Representational State Transfer. W kontekście interfejsów API Google odnosi się to używania czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.

W systemie RESTful zasoby są przechowywane w magazynie danych. Klient wysyła żądanie, aby serwer wykonał określone działanie (np. utworzenie, pobranie, zaktualizowanie lub usunięcie zasobu), a serwer wykonuje to działanie i wysyła odpowiedź, często w formie reprezentacji określonego zasobu.

W interfejsach API REST Google klient określa działanie za pomocą czasownika HTTP, takiego jak POST, GET, PUT lub DELETE. Określa on zasób za pomocą niepowtarzalnego globalnie identyfikatora URI o tym kształcie:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne w ramach protokołu HTTP, co umożliwia korzystanie z przechowywania danych w pamięci podręcznej i optymalizuje działanie w rozproszonej infrastrukturze sieci.

Przydatne mogą być definicje metod w dokumentacji standardów HTTP 1.1. Obejmują one specyfikacje GET, POST, PUT i DELETE.

Interfejs REST w interfejsie API wyszukiwania w Grafie wiedzy Google

Operacje interfejsu API wyszukiwarki Google Knowledge Graph są mapowane bezpośrednio na czasowniki HTTP w interfejsie REST.

Formaty identyfikatorów URI interfejsu Google Knowledge Graph Search API:

https://kgsearch.googleapis.com/v1/entities:search?query=your_query&parameters

Pełny zestaw identyfikatorów URI używanych do każdej obsługiwanej operacji w interfejsie API jest podany w dokumentacji interfejsu Google Knowledge Graph Search API.

Podstawy formatu JSON

Interfejs Google Knowledge Graph Search API zwraca dane w formacie JSON.

JSON (JavaScript Object Notation) to powszechny format danych niezależny od języka, który zapewnia prostą tekstową reprezentację dowolnych struktur danych. Więcej informacji znajdziesz na stronie json.org.