CompanyOperations - להוסיף מסמך בשביל הבית עסק - (Add document to company)
מתי להשתמש בפונקציה זו?
במקרה ויש צורך להוסיף מסמך כלשהו לבית העסק בממשק של הספקים.
כגון: תעודת זהות, דרכון, אישור ניהול חשבון בנק ורישיון / אישור עבודה לעסק יכולים להשתמש בפונקציה זאת על מנת להוסיף את המסמך לבית עסק.
להלן קישור לפונקציה בJSON.
https://secure.cardcom.solutions/api/v11/CompanyOperations/AddDocumentToCompany
להלן הפרמטרים שצרים להעביר בפונקציה .
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | DocumentsInfo מערך של אובייקטים. |
DocType:
----- Name - string ---- Content - (String) |
DocType- סוג מסמך שמעבירים. ---- Name - השם בעליו מעבירים את המסמך. --- Content - תיאור לשם קובץ |
| 2 | SupplierUserName | (String) | שם ספק. |
| 3 | SupplierPassword | (String) | סיסמת ספק. |
| 4 | Secret | (String) | סוד. |
| 5 | CompanyInternalID | (String) | מספר בית עסק פנימי. |
RESPONSE של Add document to company.
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | ResponseCode | 0 | קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה. |
| 2 | Description | "OK" | תיאור התשובה. ''OK'' זה טוב. |
| 3 | CompanyInternalID | "2154" | מספר בית עסק פנימי. |
| 4 | TerminalNumber | 1000 | מספר מסוף של הבית עסק. |
| 5 | APIUserName | "test2025" | שם משתמש API |
| 6 | APISecret | (String) | סוד API |
| 7 | ModulesList מערך של (String) | "הוראת קבע" דפי נחיתה" פרופיל נמוך" | רשימת המודלים של בית העסק. |
| 8 | UpayAPIKey | (String) | מפתח API של UPAY. |
| 9 | ShowErrorToEndUser | boolean - true \ false. | האם להראות שגיאה ללקוח קצה? |
| 10 | CardComSapakNumber | (String) | מספר ספק קארדקום במקרה ויש. |
| 11 | CompanyNumber | 21351 | מספר פנימי של בית העסק. |
להלן קוד לדוגמא לפונקציה ביחד עם התשובה.
דוגמא לקריאה:
דוגמא לתשובה המתקבלת: