מעבר לתוכן
Unisoftתיעוד למפתחים

REST API / v2

אימות

מפתח אחד, תחום גישה מוגדר והרשאות מפורשות.

סביבת התיעוד · ייצורhttps://api.unisoft.world/integrations/v2

שלחו את המפתח בכותרת Authorization: Bearer או X-API-Key. לעולם אל תכללו אותו בכתובת URL או בקוד ציבורי של אתר.

Authorization: Bearer ke_live_REPLACE_WITH_YOUR_KEY

המפתח ke_live_ משויך לארגון אחד בלבד. הרשאות קריאה, כתיבה ושליחה נפרדות זו מזו. בכל פעולה מצוינות ההרשאות שהיא מקבלת.

הבנת שגיאה

401 MISSING_API_KEY או INVALID_API_KEY: בדקו את המפתח, הכותרת והסביבה. 403 INSUFFICIENT_SCOPE: בדקו את ההרשאות הנדרשות לפעולה.

שגיאות עסקיות אחרות מתועדות לכל פעולה בנפרד. שמרו את קוד ה-HTTP ואת השדה error כדי לאבחן כשל.

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

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