Na większości stron dokumentacji po prawej stronie ekranu widać skróconą wersję Eksploratora interfejsów API. Jeśli narzędzie APIs Explorer nie jest widoczne, kliknij Wypróbuj, aby wyświetlić jego skróconą wersję.
Jeśli po prawej stronie strony dokumentacji referencyjnej nie widzisz przycisku Wypróbuj, oznacza to, że metoda nie jest obsługiwana przez narzędzie APIs Explorer. Na przykład narzędzie APIs Explorer nie jest zgodne z interfejsami API, które wymagają kont usług, więc nie pojawia się na stronach dokumentacji tych interfejsów.
Wyświetlanie rozwiniętej wersji narzędzia APIs Explorer
Rozwinięta wersja narzędzia APIs Explorer zawiera przykłady kodu cURL, HTTP i być może inne. Aby wyświetlić rozszerzoną wersję narzędzia APIs Explorer, kliknij Pełny ekran .
Wykonaj metodę
Eksplorator interfejsów API umożliwia wprowadzanie wymaganych i opcjonalnych parametrów oraz, w stosownych przypadkach, treści żądania dla metod interfejsu API. W przypadku wielu metod REST, takich jak metody list, wystarczy wypełnić 1 lub 2 pola, aby można było wykonać metodę. Na przykład metoda books.volumes.list interfejsu Books API wymaga tylko parametru zapytania (q), aby wyświetlić listę książek. Aby wypróbować metodę books.volumes.list:
- Otwórz
books.volumes.list. - Jeśli nie widzisz narzędzia APIs Explorer, kliknij Wypróbuj.
- W polu
qwpisz Igrzyska śmierci (bez cudzysłowu ani znaków specjalnych). - Przewiń w dół i kliknij Wykonaj.
- (opcjonalnie) Na ekranie logowania w Google pojawi się prośba o wybranie konta Google.
- (opcjonalnie) Pojawi się okno autoryzacji Google z pytaniem, czy zezwalasz na „Zarządzanie książkami”. Kliknij Zezwól. Wyniki pojawią się pod przyciskiem Wykonaj.
Jeśli w APIs Explorer pojawi się wynik 200, oznacza to, że metoda została wykonana prawidłowo.
Rozwiązywanie problemów z API Explorer
Pojawił się błąd 401 lub 403
Jeśli podczas wykonywania metody za pomocą interfejsu API Explorer otrzymujesz błąd 401 lub 403, prawdopodobnie jest to spowodowane jednym z tych problemów:
- Używasz nieprawidłowego typu autoryzacji (klucza API zamiast OAuth 2.0). Spróbuj zmienić typ autoryzacji.
- Używasz OAuth 2.0, ale z zbyt wąskim zakresem. Spróbuj użyć szerszego zakresu.
Nie pojawia się okno autoryzacji
Eksplorator interfejsów API używa wyskakującego okienka, aby przyznać dostęp do Twoich danych prywatnych. Jeśli przeglądarka blokuje wyskakujące okienka, to okienko się nie pojawi i nie będziesz mieć możliwości przyznania dostępu.
Jeśli w oknie autoryzacji klikniesz Zezwól i nic się nie stanie, spróbuj zmienić ustawienia wyskakujących okienek w przeglądarce, aby je włączyć.