Zanim zaczniesz kodować swoją pierwszą aplikację kliencką, musisz zrobić kilka rzeczy.
Załóż konto Google
Aby utworzyć projekt w Konsoli interfejsów API Google, musisz mieć konto Google. Jeśli masz już konto, nie musisz nic robić.
Możesz też utworzyć oddzielne 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 tego interfejsu API. W tym celu użyj Konsoli interfejsów API Google, aby utworzyć projekt, czyli nazwany zbiór ustawień i informacji o dostępie do interfejsu API, a następnie 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.
Utwórz klucz interfejsu API swojej aplikacji, jeśli jeszcze go nie masz. Aby to zrobić, kliknij Utwórz dane logowania > Klucz interfejsu API. Następnie odszukaj klucz interfejsu API w sekcji Klucze interfejsu API.
Podstawy REST
Interfejs API można wywołać na 2 sposoby:
- wysyłanie żądań HTTP i analizowanie odpowiedzi;
- Za pomocą bibliotek klienta.
Jeśli zdecydujesz się nie używać bibliotek klienta, musisz znać podstawy REST.
REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do żądania i modyfikowania danych.
Skrót REST to reprezentatywny transfer stanowy. 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 REST 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 działanie i wysyła odpowiedź, często w formie reprezentacji określonego zasobu.
W interfejsach API typu REST firmy Google klient określa działanie za pomocą czasownika HTTP, takiego jak POST
, GET
, PUT
lub DELETE
. Wskazuje zasób za pomocą globalnie unikalnego identyfikatora URI o następującej postaci:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Ponieważ wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, interfejs REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem pracy z rozproszoną infrastrukturą sieciową.
Definicje metod znajdziesz w dokumentacji standardów HTTP 1.1. Obejmują one specyfikacje GET
, POST
, PUT
i DELETE
.
REST w interfejsie Google Knowledge Graph Search API
Operacje wyszukiwania w interfejsie Google Knowledge Graph API bezpośrednio mapują się na czasowniki HTTP REST.
Identyfikatory URI interfejsu Google Knowledge Graph Search API mają konkretne formaty:
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
Pełny zestaw identyfikatorów URI używanych w każdej obsługiwanej operacji w interfejsie API znajduje się w dokumentacji interfejsu Google Knowledge Graph API.
Podstawy kodu 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 w prosty sposób przedstawia dowolne struktury danych w formie tekstowej. Więcej informacji znajdziesz na stronie json.org.