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

קריאה לשיטה

POST או GET, גוף לעומת מחרוזת שאילתה, ומה בודק מאמת השדות.

שם השיטה הוא חלק מה-URL. כל קלט אחר, כולל מזהה, הוא פרמטר: שדה בגוף JSON ב-POST, ופרמטר במחרוזת השאילתה ב-GET. שתי הצורות מגיעות לאותה שיטה ומחזירות את אותה מעטפת.

POST: גוף JSON

הצורה הרגילה לכל קריאה עם יותר משני פרמטרים, או עם אובייקט מקונן או מערך.

curl -s https://xuda.ai/cpi/agent_domain_connect \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","domain":"example.com","subdomain":"app"}'
const res = await fetch('https://xuda.ai/cpi/agent_domain_connect', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    domain: 'example.com',
    subdomain: 'app',
  }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data);
import requests

res = requests.post(
    'https://xuda.ai/cpi/agent_domain_connect',
    json={'api_key': 'YOUR_API_KEY', 'domain': 'example.com', 'subdomain': 'app'},
)
body = res.json()
if body['code'] > 0:
    print(body['data'])

GET: מחרוזת שאילתה

נוח לבדיקה מהירה משורת הכתובת בדפדפן או משורה אחת של curl. השרת מנתח את מחרוזת השאילתה לאותו גוף שמטפל השיטה רואה, ולכן הכללים שלהלן חשובים כאן יותר מאשר ב-POST.

cURL
curl -s 'https://xuda.ai/cpi/agent_domain_connect?api_key=YOUR_API_KEY&domain=example.com&subdomain=app'

הסוג המוצהר של שדה קובע איך ערך מחרוזת השאילתה נקרא:

  • string: משמש כמות שהוא.
  • number: עובר דרך Number(...).
  • boolean: רק המחרוזת true נקראת כ-true. כל דבר אחר שמעבירים לשדה בוליאני ב-GET, כולל false, הופך ל-1 שנחשב אמת. אם ערך בוליאני חשוב, שולחים אותו ב-POST עם true/false אמיתי של JSON, או פשוט משמיטים את הפרמטר כדי להשאיר אותו בברירת המחדל של השיטה.
  • object / array: הערך עובר דרך JSON.parse(...), ולכן ערך מקונן ב-GET צריך להיות פרמטר שאילתה אחד שמחזיק מחרוזת JSON (filters=%7B%22status%22%3A%22open%22%7D), ולא קינון בסגנון סוגריים מרובעים.

שדות חובה ושגיאות סוג

לכל שדה של שיטה יש דגל mandatory ו-type. אם חסר שדה חובה, או נשלח סוג שגוי ב-POST (שבו שום דבר לא מומר אוטומטית), מקבלים בחזרה -1 עוד לפני שהשיטה עצמה רצה:

json
{ "code": -1, "data": "Error: 'domain' is a mandatory field" }
json
{ "code": -1, "data": "Error: 'domain' is a wrong type" }

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

הצעד הבא