אימות
מפתחות API של חשבון, גישה מלאה לעומת גישה מותאמת, ואיפה יוצרים מפתח.
כל קריאה ל-CPI נושאת מפתח API. אין מזהה לקוח נפרד, אין לחיצת יד של OAuth ואין חתימה לחשב: מפתח אחד, שנשלח עם הבקשה.
יצירת מפתח
המפתחות נמצאים בלוח הבקרה, במסך מפתחים בתפריט החשבון, בלשונית מפתחות API. לפרויקט יש
לשונית API משלו שיוצרת את אותו סוג מפתח כשהוא כבר מוגבל לפרויקט, כך שלא צריך להקליד app_id
ידנית. ארגז החול האינטראקטיבי של מדריך ה-API יכול גם הוא ליצור מפתח במקום, כך
שאפשר לנסות שיטה לפני ששולבה בקוד שלכם.
יצירת מפתח API דורשת אימות זהות, אותה בדיקה ברמה 2 ש-Xuda דורשת לפני שהיא נותנת מספר טלפון, תיבת דואר או IP נייד. חשבון שלא אומת בו דבר רואה הנחיה לאמת לפני שטופס המפתח נפתח.
היקף: באיזה חשבון המפתח פועל
מפתח נוצר באחד משלושה היקפים, ותמיד פועל על החשבון או האפליקציה שנוצר מולם:
- חשבון: פועל ישירות על החשבון שלכם, כמו שהייתם פועלים ממושב מחובר בלוח הבקרה. מגיע לכל שיטה שמפתח חשבון רגיל יכול להגיע אליה.
- אפליקציה: נוצר מלשונית ה-API של פרויקט, וננעל ל-
app_idשל אותו פרויקט. - Full Stack VPS: מונפק אוטומטית כשמקימים Full Stack VPS, ומוגבל לקבוצות היכולות שנבחרו בזמן היצירה. ראו Full Stack VPS למה שזה מכסה.
גישה: מלאה או מותאמת
כל מפתח בוחר גם כמה מהמשטח הציבורי הוא יכול להגיע אליו:
- גישה מלאה: כל מה שהחשבון יכול לעשות דרך ה-API, כולל שיטות שנוספו אחרי שהמפתח נוצר. שיטות
פרטיות נשארות מחוץ לתחום בכל מקרה:
private: trueהיא חומה קשיחה שנבדקת בכל קריאה, ולא ברירת מחדל שגישה מלאה עוקפת. - גישה מותאמת: רשימת היתרים מפורשת שבונים בסימון שיטות בטופס המפתח, מקובצות לפי מיקרו-שירות
כשהשדות של כל שיטה מוצגים בתוך השורה. שיטה שנוספה מאוחר יותר לא נכללת עד שחוזרים ומתירים
אותה. שיטה שה-
clearanceשלה הואpublicנגישה תמיד, גם למפתח מותאם שלא סומן בו דבר, כי שיטה ציבורית לא צריכה מושב ולא רשומה ברשימת ההיתרים.
השיטות שיוצרות, מעדכנות ומציגות מפתחות API (create_account_api_key,
get_app_api_keys ושאר api_module) אף פעם לא נגישות עם מפתח API, בכוונה:
אישור גישה לא יכול ליצור או לערוך אישורי גישה לחשבון שהוא מאמת. מנהלים מפתחות מלוח הבקרה או
ממושב מחובר.
שליחת המפתח
ב-REST רגיל המפתח הוא עוד פרמטר בבקשה, בשם api_key: שדה בגוף ה-JSON ב-POST, ופרמטר במחרוזת
השאילתה ב-GET. ראו קריאה לשיטה לשתי הצורות.
ב-MCP אותו מפתח עובר בכותרת Authorization: Bearer במקום, ואין שדה api_key. ראו MCP.
מפתח API הוא אישור גישה למחזיק בו: מי שמחזיק בו פועל כחשבון שלכם. לעולם לא לשלוח אותו בקוד צד לקוח, לא לשמור אותו ב-commit ולא להדביק אותו בצילום מסך משותף. אם הוא הופיע באחד המקומות האלה, מחליפים אותו מיד: ההחלפה שומרת את השם ואת מצב הגישה, ומבטלת את הערך הישן באותו צעד.