Contacts API
להוספת לקוח פוטנציאלי ממקור חיצוני
להוספת לקוח ממקור חיצוני
נא לשים לב!
- הנתונים צריכים להישלח ב UTF8
- כל הנתונים צריכים להישלח ב POST
- יש להשתמש ב content type: application/x-www-form-urlencoded
שדות הבקשה
| שם השדה | סוג | תאור | ערכים אפשריים | ברירת מחדל | חובה | |
|---|---|---|---|---|---|---|
x_name |
varchar |
שם הלקוח | כן | |||
client_type_label |
varchar |
סוג לקוח | לא | |||
client_status_label |
varchar |
סטטוס לקוח | לא | |||
x_identify_number |
varchar |
תעודת זהות הלקוח | לא | |||
x_birthday |
Date |
תאריך לידה | dd/mm/yyyy | לא | ||
x_email1 |
varchar |
אימייל הלקוח | לא | |||
x_phone |
varchar |
טלפון הלקוח | לא | |||
x_mobile |
varchar |
טלפון נייד | לא | |||
x_address |
varchar |
כתובת הלקוח | לא | |||
x_city |
varchar |
עיר הלקוח | לא | |||
x_referrer |
integer |
מקור הפניה |
ערכים בהתאם לערכים בתוכנה |
לא | ||
x_referrer_notes |
varchar |
הערות מקור הגעה | לא | |||
x_comments |
varchar |
הערות/תאור | לא | |||
x_is_club_member |
varchar |
חבר מועדון | "Y","N" | N | לא | |
newsletter_group_label |
varchar |
קבוצת ניוזלטר | לא | |||
connect_to_project |
project_id | number | מזהה של הפרויקט | null | לא | |
connect_to_project |
description | text | לא | |||
connect_to_project |
amount | float | סכום לחיוב כולל מע"מ | לא | ||
connect_to_project |
start_date | date | תאריך הצטרפות | לא | ||
connect_to_project |
finish_date | date | תאריך סיום שרות | לא | ||
connect_to_project |
recurrence | text | מחזוריות עסקה | "NO", "MONTH" | NO | לא |
connect_to_project |
num_of_payment | number | מספר חודשי שירות | לא | ||
test |
varchar |
בדיקה - ידפיס למסך את הפרמטרים שנשלחו ללא המשך | test | לא | ||
תגובה
התשובה שתיתקבל היא בפורמט JSON.
במיקרה של הצלחה
קוד HTTP : 200
לדוגמה:
{
"success": 1,
"data": {
"id": 2335
}
}
id - מס לקוח שנוצר
במיקרה של כישלון
קוד HTTP : 400-599
הודעת שגיאה - error
לדוגמה:
{
"success": 0,
"message": "Incorrect business number"
}
ניתן לראות קוד לדוגמא
דוגמאות
הוספת לקוח
POST extapi/client/add.php?username=api_user&password=secret
Content-Type: application/x-www-form-urlencoded
x_name=Israel%20Israeli&x_email1=client@example.com&x_phone=0501234567&x_city=Tel%20Aviv
הוספת לקוח פוטנציאלי
POST extapi/pclient/add.php?username=api_user&password=secret
Content-Type: application/x-www-form-urlencoded
x_name=Dana%20Levi&x_email1=dana@example.com&x_mobile=0521234567