ברוב דפי התיעוד, בצד שמאל של המסך מוצג API Explorer מצומצם. אם APIs Explorer לא מוצג, לוחצים על Try it! כדי להציג את הגרסה המצומצמת של APIs Explorer.
אם הלחצן Try it! לא מופיע בצד שמאל של דף תיעוד של הפניה, סימן שהשיטה לא נתמכת ב-APIs Explorer. לדוגמה, APIs Explorer לא תואם לממשקי API שדורשים חשבונות שירות, ולכן הוא לא מופיע בדפי התיעוד של ממשקי ה-API האלה.
הצגת הגרסה המורחבת של APIs Explorer
הגרסה המורחבת של הכלי APIs Explorer מכילה דוגמאות קוד של cURL, HTTP ואולי גם של שפות אחרות. כדי להציג את הגרסה המורחבת של הכלי APIs Explorer, לוחצים על סמל המסך המלא .
ביצוע שיטה
ב-APIs Explorer אפשר להזין פרמטרים נדרשים, פרמטרים אופציונליים, ובמקרה הצורך, גוף בקשה לשיטות API. במקרים רבים, כמו בשיטות של רשימות, צריך למלא רק שדה אחד או שניים לפני שאפשר להפעיל את השיטה. לדוגמה, כדי להפעיל את השיטה books.volumes.list ב-Books API, צריך רק פרמטר שאילתה (q) כדי לרשום ספרים. כדי לנסות את השיטה של books.volumes.list:
- ניווט אל
books.volumes.list. - אם APIs Explorer לא מוצג, לוחצים על רוצה לנסות?
- בשדה
q, מקלידים Hunger Games (ללא גרשיים או תווים מיוחדים). - גוללים למטה ולוחצים על Execute (הפעלה).
- (אופציונלי) במסך הכניסה לחשבון Google, בוחרים חשבון Google.
- (אופציונלי) בתיבת דו-שיח של הרשאה ב-Google, תישאל השאלה אם אתם רוצים "לנהל את הספרים שלכם". לוחצים על אישור. התוצאות מופיעות מתחת ללחצן Execute (הפעלה).
אם ב-APIs Explorer מוצגת תוצאה של 200, סימן שהשיטה הצליחה.
פתרון בעיות ב-APIs Explorer
קיבלת שגיאה 401 או 403
אם מופיעה שגיאת 401 או 403 כשמריצים שיטה באמצעות APIs Explorer, סביר להניח שהבעיה נובעת מאחת מהסיבות הבאות:
- אתם משתמשים בסוג הרשאה שגוי (מפתח API במקום OAuth 2.0). אפשר לנסות לשנות את סוג ההרשאה.
- אתם משתמשים ב-OAuth 2.0, אבל בהיקף צר מדי. כדאי לנסות להשתמש בהיקף רחב יותר.
תיבת הדו-שיח של ההרשאה לא מופיעה
ב-APIs Explorer, מופיע חלון קופץ שבו צריך לאשר גישה לנתונים הפרטיים. אם הדפדפן חוסם חלונות קופצים, החלון הקופץ הזה לא יופיע ולא תוכלו להעניק גישה.
אם לוחצים על אישור בתיבת הדו-שיח של ההרשאה ולא קורה כלום, צריך לנסות לשנות את הגדרות החלונות הקופצים בדפדפן כדי לאפשר את הצגתם.