כשהאפליקציה מעבירה בקשה לנתונים ציבוריים אין צורך לקבל הרשאה לכך, אבל יש לצרף לבקשה מזהה כלשהו כמו מפתח API.
האפליקציה צריכה לזהות את עצמה בכל פעם שהיא שולחת בקשה לממשק ה-API של Google Knowledge Graph, על ידי הכללת מפתח API עם כל בקשה.
רכישה של מפתח API ושימוש בו
כדי לרכוש מפתח API:
- פותחים את דף פרטי הכניסה ב-API Console.
-
ממשק ה-API הזה תומך בשני סוגים של פרטי כניסה.
יוצרים את פרטי הכניסה המתאימים לפרויקט:
-
OAuth 2.0: בכל פעם שהאפליקציה שלך מבקשת נתוני משתמש פרטיים, עליה לשלוח אסימון OAuth 2.0 בנוסף לבקשה. קודם כל, האפליקציה שולחת מזהה לקוח, וגם סוד לקוח כדי לקבל אסימון. אפשר ליצור פרטי כניסה בפרוטוקול OAuth 2.0 לאפליקציות אינטרנט, לחשבונות שירות או לאפליקציות מותקנות.
הערה: ה-API הזה לא כולל שיטות שמחייבות הרשאה של OAuth 2.0, ולכן ייתכן שיהיה עליך להשיג רק מפתחות API כפי שמתואר בהמשך. עם זאת, אם האפליקציה שלך מתקשרת לממשקי API אחרים שמחייבים הרשאת משתמש, עדיין תצטרך פרטי כניסה בפרוטוקול OAuth 2.0.
למידע נוסף, עיינו בתיעוד של OAuth 2.0.
-
מפתחות API: בקשה שלא מספקת אסימון OAuth 2.0 חייבת לשלוח מפתח API. המפתח מזהה את הפרויקט ומספק גישה ל-API, מכסה ודוחות.
ממשק ה-API תומך במספר סוגים של הגבלות על מפתחות API. אם מפתח ה-API שנחוץ לא קיים, יש ליצור מפתח API במסוף. לשם כך לוחצים על יצירת פרטי כניסה > מפתח ה-API. אפשר להגביל את המפתח לפני שמשתמשים בו בסביבת הייצור בלחיצה על Restrict key ואז על אחת מההגבלות.
-
כדי להגן על מפתחות ה-API, כדאי לפעול לפי השיטות המומלצות לשימוש מאובטח במפתחות API.
אחרי שמקבלים מפתח API, האפליקציה יכולה לצרף את פרמטר השאילתה key=yourAPIKey לכל כתובות ה-URL של הבקשות.
מפתח ה-API בטוח להטמעה בכתובות URL, ללא צורך בקידוד.