תחילת השימוש ב-Looker API

‫Looker API הוא ממשק מאובטח לתכנות אפליקציות (API) מסוג RESTful, שמאפשר לנהל את מכונת Looker ולאחזר נתונים דרך פלטפורמת הנתונים של Looker. באמצעות Looker API, אתם יכולים לכתוב אפליקציות או סקריפטים לאוטומציה כדי להקצות חשבונות משתמשים חדשים ב-Looker, להריץ שאילתות, לתזמן מסירות נתונים וכו'. כמעט כל מה שאפשר לעשות באפליקציית Looker אפשר לעשות באמצעות Looker API.

נתיב ויציאה של Looker API

ניגשים ל-API של מופע Looker דרך כתובת ה-URL של ה-API.

אדמין ב-Looker יכול להזין נתיב API בשדה כתובת ה-URL של מארח ה-API בדף אדמין > API בפורמט הבא:

https://<instance_name>.cloud.looker.com

יכול להיות שאדמין Looker ישתמש גם בשדה API Host URL כדי להקצות נתיב API ששונה משם המכונה של שרת Looker. זה קורה בדרך כלל כשההתקנה של Looker נמצאת מאחורי מאזן עומסים, למשל. במקרה כזה, צריך לפנות לאדמין של Looker כדי לקבל את נתיב ה-API.

אם האדמין שלכם ב-Looker לא ציין את השדה API Host URL, ‏ Looker משתמש בנתיב ברירת המחדל של ה-API. במקרים של מופעי Looker שמארחים ב-Google Cloud, ב-Microsoft Azure ובמופעים שמארחים ב-Amazon Web Service ‏ (AWS) ושנוצרו בתאריך 7 ביולי 2020 או אחריו, נתיב Looker API שמוגדר כברירת מחדל משתמש ביציאה 443. במקרים של מופעי Looker שמתארחים ב-AWS ונוצרו לפני 7 ביולי 2020, נתיב ברירת המחדל של Looker API משתמש ביציאה 19999. כתובת ה-URL של ה-API שמוגדרת כברירת מחדל היא בפורמט הבא:

https://<instance_name>.cloud.looker.com:<port>

ערכות SDK של לקוח

אפשר להשתמש ב-Looker API עם כל שפת תכנות או סביבת אפליקציות שיכולות לשלוח בקשות HTTPS ולעבד תשובות JSON. אפשר ליצור בקשות HTTPS ל-Looker API באופן ידני באמצעות curl (או כלי מקביל), באמצעות Looker Ruby SDK, או באמצעות יצירה של ספריית לקוח SDK בשפה הרצויה. אנחנו ממליצים להשתמש ב-SDK כי הוא מטפל בפרטים של אימות ובבקשות HTTPS בשבילכם, כך שתוכלו לקרוא ל-Looker API באמצעות קריאות פשוטות לפונקציות.

פרטים על ערכות ה-SDK זמינים בדף התיעוד בנושא ערכות SDK של Looker API.

אימות

‫Looker מאמת בקשות ל-API באמצעות אסימון גישה מסוג OAuth 2.0 בכותרת ההרשאה של HTTP בבקשה. כל נקודות הקצה ב-Looker API דורשות חיבור HTTPS מאובטח, כדי שטוקן הגישה יהיה מאובטח בזמן ההעברה.

השלבים לביצוע הפעולה הזו משתנים בהתאם לשאלה אם אתם משתמשים ב-SDK. הוראות מפורטות זמינות בדף התיעוד בנושא אימות Looker API.

תיעוד אינטראקטיבי של ה-API

תוסף API Explorer זמין ב-Looker Marketplace. מידע נוסף זמין בדף התיעוד בנושא שימוש ב-API Explorer. אדמינים של Looker יכולים גם לגשת אל API Explorer בלחיצה על הקישור Use API Explorer בדף API Admin ב-Looker.

ניהול גרסאות

יציבות ה-API היא שיקול חשוב כשמפתחים אפליקציות. כדי לעזור לכם להבין אילו נקודות קצה עשויות להשתנות בעתיד ואילו צפויות להישאר יציבות, אנחנו מסמנים נקודות קצה מסוימות כנקודות קצה בגרסת בטא. מידע נוסף מופיע בדף התיעוד בנושא ניהול גרסאות של Looker API.