ה API הבא מאפשר יצירת לקוח או עריכת לקוח קיים. המערכת מחפשת לקוח קיים לפי vat_id.
הפניה צריכה להיות (תמיד) מוצפנת דרך https וניתן לפנות ב POST או ב GET.
הכתובת אליה צריך להפנות את קריאות הAPI היא:
https://api.icount.co.il/api/v1.php
התגובה תתקבל בפורמט json בלבד.
שם השדה | סוג | תיאור | ערכים אפשריים | ברירת מחדל | חובה |
---|---|---|---|---|---|
פרמטרים | |||||
compID | varchar | מזהה החברה שלך | כן | ||
user | varchar | שם משתמש | כן | ||
pass | varchar | סיסמה | כן | ||
action | varchar | סוג הפעולה. במקרה הזה זה תמיד create_update_client | כן | ||
clientname | varchar | שם הלקוח | לא | ||
client_street_number | varchar | מספר בית | לא | ||
client_street | varchar | שם הרחוב | לא | ||
client_city | varchar | שם העיר | לא | ||
client_zip | varchar | מיקוד | לא | ||
varchar | כתובת אימייל | לא | |||
mobilephone | varchar | טלפון נייד | לא | ||
phone | varchar | טלפון | לא | ||
fax | varchar | פקס | לא | ||
fname | varchar | שם פרטי של איש הקשר הראשי | לא | ||
lname | varchar | שם משפחה של איש הקשר הראשי | לא | ||
client_country | varchar | מדינה | לא | ||
bank | int | מספר בנק | לא | ||
branch | int | מספר סניף | לא | ||
account | int | מספר חשבון | לא | ||
custom_client_id | int | מספר לקוח מיוחד | לא | ||
vat_id | varchar | 9 ספרות – מספר תעודת זהות/ חפ / עמ של הלקוח | מספרים בלבד | כן | |
no_digsig | tinyint | האם לאפשר ללקוח חתימה דיגיטלית | 1,0 | 0 | לא |
faccount | int | מספר חשבון זר (המערכת תקצה אוטומטית מספר אם לא מספקים מספר) | מספרים בלבד | לא | |
update_existing | int | האם לעדכן כרטיס לקוח קיים במידה ונמצא כרטיס של לקוח כזה | 1,0 | 0 | לא |
התשובה החוזרת תיראה ככה:
( 'status' => 'ok', 'client_id' => 12345 )