Zanim zaczniesz pisać pierwszą aplikację kliencką, musisz wykonać kilka czynności:
Uzyskaj konto Google
Aby móc 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ż potrzebować osobnego konta 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 i włączania interfejsu API.
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 znajdź swój klucz interfejsu API.
Poznaj podstawy REST
Interfejs API można wywołać na 2 sposoby:
- wysyłanie żądań HTTP i parsowanie odpowiedzi,
- korzystanie z bibliotek klientów.
Jeśli zdecydujesz się nie korzystać z bibliotek klienta, musisz poznać podstawy REST.
REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do wysyłania żądań dotyczących danych i ich modyfikowania.
REST to skrót od „Representational State Transfer”. W kontekście interfejsów API Google oznacza to używanie 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. utworzył, pobrał, zaktualizował lub usunął zasób), 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 zasób za pomocą unikalnego globalnie identyfikatora URI w tej postaci:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Ponieważ wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem współpracy z rozproszoną infrastrukturą internetu.
W dokumentacji standardów HTTP 1.1 znajdziesz definicje metod, w tym specyfikacje metod GET, POST, PUT i DELETE.
REST w interfejsie Google Knowledge Graph Search API
Operacje interfejsu Google Knowledge Graph Search API są bezpośrednio powiązane z czasownikami REST HTTP.
Identyfikatory URI interfejsu Google Knowledge Graph Search API mają te formaty:
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
Pełny zestaw identyfikatorów URI używanych w przypadku każdej obsługiwanej operacji w interfejsie API znajdziesz w dokumencie Dokumentacja interfejsu Google Knowledge Graph Search API.
Poznaj podstawy formatu JSON
Interfejs Google Knowledge Graph Search API zwraca dane w formacie JSON.
JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który zapewnia prostą tekstową reprezentację dowolnych struktur danych. Więcej informacji znajdziesz na stronie json.org.