ה API הבא מאפשר משיכת מידע קישורים למסמכים ממערכת iCount. הפניה צריכה להיות (תמיד) מוצפנת דרך https וניתן לפנות ב POST או ב GET.
הכתובת אליה צריך להפנות את קריאות הAPI היא:
https://api.icount.co.il/api/v1.php
שם השדה | סוג | תיאור | ערכים אפשריים | ברירת מחדל | חובה |
---|---|---|---|---|---|
פרמטרים | |||||
compID | varchar | מזהה החברה שלך | כן | ||
user | varchar | שם משתמש | כן | ||
pass | varchar | סיסמה | כן | ||
action | varchar | סוג הפעולה. במקרה הזה זה תמיד get_doclink | כן | ||
docnum | varchar | מספר מסמך | כן | ||
doctype | varchar | סוג מסמך מסמך[invoice,receipt,invrec,refund,offer,deal,delcert,trec] | כן | ||
lang | varchar | שפת המסמך. ברירת מחדל היא he אבל אפשר לשלוח גם en אם רוצים אנגלית | |||
orig | varchar | האם רוצים קישור למקור או להעתק? ברירת מחדל היא מקור. אם רוצים העתק יש לשלוח 0 | |||
hidenis | varchar | כשמסובר במסמך מטו"ח ניתן לשלוח כאן ערך 1 על מנת להסתיר את השרלים. ברירת מחדל כאן היא לא להסתיר את השקלים | |||
method | varchar | באיזו צורה תרצו חקבל תשובה מהמערכת? האפשרויות הן: xml, json. |
התשובה החוזרת תכיל שני ערכים: doclink ו pdf_link. doclink ייקח את הלקוח למסמך דרך המערכת ו pdf_link ייקח את הלקוח ישירות ל PDF.