Wyświetlanie eksploratora interfejsów API i wykonywanie metody

Na większości stron z dokumentacją zwinięty interfejs Explorer API jest widoczny po prawej stronie. Jeśli eksplorator interfejsów API nie jest widoczny, kliknij Wypróbuj, aby wyświetlić skróconą wersję.

Jeśli opcja Try it! (Wypróbuj) nie pojawi się w prawej części strony z plikami referencyjnymi, ta metoda nie będzie obsługiwana w Eksploratorze interfejsów API. Na przykład eksplorator interfejsów API nie jest zgodny z interfejsami API, które wymagają kont usługi, dlatego nie jest on dostępny na stronach dotyczących tych interfejsów API.

Wyświetl rozszerzoną wersję eksploratora interfejsów API

Rozwinięta wersja eksploratora interfejsów API zawiera kodowanie cURL, HTTP i inne przykłady kodu. Aby wyświetlić rozszerzoną wersję eksploratora interfejsów API, kliknij Pełny ekran .

Wykonaj metodę

Eksplorator interfejsów API umożliwia wpisanie wymaganych parametrów i parametrów opcjonalnych, a w razie potrzeby także treści żądania dla metod interfejsu API. W przypadku wielu metod REST, takich jak listy, wystarczy wypełnić jedno lub dwa pola, zanim będzie można je wykonać. Na przykład metoda interfejsu API Książek books.volumes.list wymaga tylko parametru zapytania (q) do wyświetlenia listy książek. Aby wypróbować metodę books.volumes.list:

  1. Otwórz stronę books.volumes.list.
  2. Jeśli eksplorator interfejsów API nie jest wyświetlany, kliknij Wypróbuj.
  3. W polu q wpisz Igrzyska olimpijskie (bez cudzysłowu ani znaków specjalnych).
  4. Przewiń w dół i kliknij Wykonaj.
  5. (Opcjonalnie) Ekran logowania Google prosi o wybranie konta Google.
  6. (Opcjonalnie) W oknie autoryzacji Google pojawi się pytanie, czy można zarządzać książkami." Kliknij Zezwól. Wyniki zostaną wyświetlone pod przyciskiem Wykonaj.

Jeśli wynik zależy od wartości 200, oznacza to, że eksploracja zakończyła się powodzeniem.

Rozwiązywanie problemów z eksploratorem interfejsów API

Pojawił się błąd 401 lub 403

Jeśli podczas wykonywania metody przy użyciu eksploratora interfejsów API wystąpi błąd 401 lub 403, jest to prawdopodobnie spowodowane jednym z tych problemów:

  • Używasz nieprawidłowego typu autoryzacji (klucz interfejsu API zamiast OAuth 2.0). Spróbuj zmienić typ autoryzacji.
  • Używasz protokołu OAuth 2.0, ale ma on zawężony zakres. Spróbuj użyć szerszego zakresu.

Okno autoryzacji nie jest widoczne

Eksplorator interfejsów API używa wyskakującego okienka, by przyznać dostęp do Twoich danych prywatnych. Jeśli przeglądarka zablokuje wyskakujące okienka, nie zostanie ono wyświetlone i nie będzie można przyznać do niego dostępu.

Jeśli w oknie autoryzacji nie klikniesz żadnej opcji Zezwalaj, spróbuj zmienić ustawienia wyskakujących okienek w przeglądarce i włączyć wyskakujące okienka.