דילוג לתוכן
אומת

סקירה

נקודת קצה אחת, מעטפת תגובה אחת, ו-337 השיטות שמפתח API יכול להגיע אליהן.

כל מסך בלוח הבקרה של Xuda, כל תוכנית ב-Studio וכל שילוב של צד שלישי קוראים לאותו משטח HTTP: CPI, קיצור של מפעיל השיטות של הפלטפורמה. יש צורה אחת של נקודת קצה, /cpi/<method>, ומעטפת תגובה אחת. מי שלומד אותה פעם אחת מכסה את כל 337 השיטות שמפתח API של חשבון יכול להגיע אליהן כיום.

נקודת הקצה

POST https://xuda.ai/cpi/<method>GET  https://xuda.ai/cpi/<method>

<method> הוא שם שיטה כמו get_account_projects או dbs_read, ולעולם לא נתיב משאב עם מזהה בתוכו. כל קלט, כולל מזהה, הוא פרמטר: ב-POST זה שדה בגוף JSON, וב-GET זה פרמטר במחרוזת השאילתה (ראו קריאה לשיטה לכללי גוף מול שאילתה ולדוגמאות עבודה ב-cURL, ב-JavaScript וב-Python).

אתר התיעוד הזה

התיעוד מוגש בכתובת xuda.ai/docs, ולכן ארגז החול באתר הזה קורא ל-/cpi/<method> באותו מקור (same-origin). הקוד שלכם, שרץ בכל מקום, קורא ישירות ל-https://xuda.ai/cpi/<method>.

המעטפת

כל שיטה, בהצלחה או בכישלון, עונה באותה צורה:

json
{ "code": 1, "data": { "...": "..." } }
  • code > 0 הוא הצלחה. למספר עצמו אין משמעות מעבר לכך שהוא חיובי, קוראים את data.
  • code < 0 הוא שגיאה. data הוא בדרך כלל מחרוזת הודעה, וכשל באימות מוסיף גם שדה message שנגזר ממנה. ראו שגיאות לקודים שכדאי לפצל לפיהם ולאלה שפשוט רושמים ומציגים.
  • שיטה שמחזירה קובץ או סוג תוכן מותאם (ייצוא CSV, תמונה) מדלגת על מעטפת ה-JSON וקובעת בעצמה את הכותרות והגוף. זה היוצא מן הכלל, לא הכלל.
  • תגובה מוצלחת נושאת כותרת xu-region ששמה את אזור Xuda שטיפל בקריאה. תגובת שגיאה לא נושאת אותה.

Clearance והחומה הפרטית

כל שיטה נושאת clearance: public, user, user_access, developer או admin. זה קובע מי רשאי להגיע אליה דרך מושב מחובר בלוח הבקרה: שיטה מסוג public לא צריכה כלום, והשאר צריכות מושב ברמה הזאת או גבוהה ממנה.

מפתח API הוא חומה נפרדת, לא עוד רמת clearance. שיטה נושאת גם דגל private. private: true הוא מוחלט: שום מפתח API לא יכול לקרוא לה, גם לא מפתח עם גישה מלאה, בלי קשר ל-clearance שלה. בערך רבע מהקטלוג פתוח במובן הזה: 337 שיטות ב-24 מיקרו-שירותים, מ-Voice ו-Domains ועד Drive וממשק הכתיבה של Studio. השאר, כולל כל שיטה ב-api_module עצמו (השיטות שיוצרות ומנהלות מפתחות API), נשארות למושב בלבד. אימות מסביר על גישה מלאה לעומת גישה מותאמת של מפתח, וכל מדריך מודול בהמשך מסתיים בטבלה החיה של מה שהמיקרו-שירות שלו חושף.

איך מוצאים שיטה

מדריך ה-API האינטראקטיבי מציג את כל 337 השיטות עם השדות שלהן, ומאפשר להריץ אחת מהן מול החשבון שלכם ישר מהדפדפן.