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