כשפונים למערכת iCount באמצעות ה API, כמה דברים קורים. ראשית – המערכת תודיע שהתקבלה פניה — REQUEST_RECEIVED. לאחר מכן קוד ה API יבחן את הקריאה ויבדוק אם היא תקינה ומכילה את כל המידע הנדרש. במידה וכן – יתקבל REQUEST_OK.

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

  • ICOUNT_CLIENT_ID – יכיל את מספר הלקוח שהמערכת שייכה לו את המסמך.
  • DOCTYPE – יראה את סוג המסמך שיצא.
  • DOCNUM_RESULT – יציג את מספר המסמך שיצא.
  • EMAIL_LINK – (במידה וביקשנו לשלוח מייל) יציג את הקישור הישיר למסמך.

במידה ויש לנו בעיה עם אחד הפרמטרים, המערכת תתריע מידע דל מאוד. אם רוצים לקבל עוד מידע יש להעביר פרמטר שנקרא debug ולתת לו את הערך “yes” ואז המערכת מחזירה output בפורמט html עם הרבה מידע על כל הבדיקות שנעשות ועל בעיות במידה ויש.

דוגמה לתגובה תקינה:

REQUEST_RECEIVED
REQUEST_OK
ICOUNT_CLIENT_ID=2
DOCTYPE=INVREC
DOCNUM_RESULT=1046
EMAIL_LINK=https://xxx.icount.co.il/hash/p_print.php?code=xxxxxxxxxxxxxxxxxxxxxx&language=&o=1