הצטרפות חינם עוד היום!
הצטרפות ללא התחייבות, וללא צורך בהזנת כרטיס אשראי.
ואפשר גם בהרשמה מהירה
ברוכים הבאים לדף ההסבר על ממשק ה-API של מערכת "מכתב בקליק" מבית "דפוס בארי".
באמצעות ממשק זה, תוכלו לשלוח דואר ישירות מתוך מערכת המידע שלכם.
לפני שאתם מתחילים לכתוב קוד, יש לבצע מס' שלבים פשוטים:
1. הקמת חשבון במערכת OfficeGuy שדרכו יבוצעו פעולות ה-API.
הקמת החשבון מתבצעת באמצעות כמה קליקים, ישירות מתוך דף זה, ואינה כרוכה בתשלום.
2. קבלת פרטי התחברות עבור מערכת "מכתב בקליק".
ניתן לפנות אל ארז גתי מחברת דפוס בארי, על מנת לקבל את פרטי ההתחברות.
פרטי ההתחברות מורכבים משלושה שדות: שם משתמש, סיסמה, ומזהה רקע.
3. שמירת פרטי ההתחברות של "מכתב בקליק" בתוך מערכת OfficeGuy.
שמירת הפרטים מתבצעת מתוך הכפתור "הגדרות", תחת סרגל הפעולות.
אלו אותם פרטי ההתחברות אשר איתם אתם מתחברים לאתר מכתב בקליק.
4. הקמת מפתחות API, באמצעותם תבוצע ההתחברות.
לאחר ההתחברות למערכת, תוכלו לקבל את מפתחות ה-API מתוך הכפתור "מפתחות API", תחת סרגל הפעולות.
אלו המפתחות איתם תוכלו לפנות אל ה-API של מערכת OfficeGuy לטובת שליחת דואר.
מפתחות ה-API מורכבים משני שדות: מזהה ארגון (CompanyID), והמפתח עצמו (Key).
מזל טוב. אפשר להתחיל לכתוב קוד.
מפרט ה-API המלא והכתובת המלאה מופיעים תחת הכפתור "מפרט ב-API", תחת סרגל הפעולות. הממשק מופעל באמצעות REST/JSON.
המפרט מכיל מס' רב של שדות, להלן מס' הערות שיקלו עליכם בתהליך:
- השדות הקריטיים ביותר, הינם ה-PDF (הקובץ אותו אתם שולחים, בפורמט של Base64), פרטי הנמען (כל השדות המתחילים ב-Receipient), ומפתח ה-API (השדות CompanyID ו-APIKey).
- קיימים שדות הניתנים להגדרה מתוך הגדרות המערכת (תחת סרגל הפעולות), אשר יחסכו מכם את ניהול הגדרות אצלכם. השדות הם: כתובת השולח (SenderAddress), כתובת להחזרת מכתבים (ReturnAddress), ומזהה הרקע (BackgroundID).
- שדות נוספים, הינם שדות רשות, עם ערכי ברירת מחדל. ברירת המחדל הינה הדפסה בשחור לבן, הדפסה חד-צדדית, ושליחה באמצעות דואר רגיל.
- יש לוודא כי קבצי ה-PDF מכילים דפים בגודל A4.
- במידת הצורך, ניתן לספק את פרטי ההתחברות (Username, Password) כחלק מהפרטים הנשלחים ב-API. שיטה זו לדוגמה מאפשרת לחברות תוכנה לבצע את השליחה בשם הלקוח/ה, ללא פתיחת ארגון ייעודי לכל לקוח/ה.
- לטובת תהליך האינטגרציה בפיתוח, קיים השדה LiveMode, המאפשר את הפעלת ה-API ללא שליחת הדואר בפועל אל מערכת "מכתב בקליק".
ניתן להשאיר את השדה ריק, או עם הערך False, על מנת להישאר במצב הבדיקות של המערכת שמאפשר את הפעלת ה-API לטובת ביצוע בדיקות אינטגרציה ותקינות נתונים. - שולחים דואר רשום? ניתן לקבל את מס' המעקב חזרה באמצעות ה-API.
- מומלץ להשתמש בספריות למפתחים שלנו, שיחסכו לכם זמן רב בעבודה על האינטגרציה.
- לשימושכם, דוגמת קוד מלאה לשליחת מכתב באמצעות C#.
נשמח לעזור בתהליך האינטגרציה, במייל effy@myofficeguy.com, או בטלפון 054-7419950 (אפי).
