תוכנת Powerlink מאפשרת התממשקות לצד שלישי בעזרת מערכת ה API. ניתן לבצע פעולות של הוספה, עדכון, מחיקה, והצגה לכל סוג רשומה.

את הפעולות ניתן לבצע בעזרת שליחה וקבלת נתונים במבנה JSON ופנייה ל API בצירוף TokenID ייחודי של המערכת שלכם אותו ניתן למצוא תחת הגדרות> ממשקי אינטרנט.

כיצד ניתן לקבל Token עבור ממשק ה API ?
לחיצה על גלגל השיניים האפור בפינה השמאלית > לחיצה על ממשקי אינטרנט בתפריט מימין >> בסוף הדף נראה את ה TokenID
*לכל משתמש במערכת ישנו TokenID יחודי.

את הקריאות נוכל לבדוק בעזרת כלי המדמה קריאות HTTP לממשק ה API , בדוגמאות שלנו נשתמש ב
Postman שהינו תוסף לדפדפן Chrome וניתן להוריד אותו בחינם מחנות Chrome
בקישור הבא.

 

קריאות לממשק ניתן לבצע באמצעות קריאות HTTP בכל שפה שנרצה:
PHP
Java script
#C
וכו'

התהליך מתבצע בעזרת קריאה לכתובת URL לפי הפקודה שנרצה לבצע.


 

URL

Method

Action

https://api.powerlink.co.il/api/record/{record}

POST

Create

https://api.powerlink.co.il/api/record/{record}/{id}

PUT

Update

https://api.powerlink.co.il/api/record/{record}/{id}

DELETE

Delete

https://api.powerlink.co.il/api/query

POST

Query

https://api.powerlink.co.il/api/record/{record}/{id}

GET

Get


איך נדע מה שם המערכת של האוביקט עליו נרצה לבצע פעולות?
נלחץ על גלגל השיניים האפור בפינה השמאלית > בתפריט מצד ימין נלחץ על "הגדרת רשומות", כעת נלחץ על האוביקט ובפרטים שלו נעתיק את השם תחת השדה "שם מערכת".

שמות מערכת של אוביקטים נפוצים:
לקוחות - account
קריאות שירות - cases
משימות - task

כעת, לאחר שמצאנו את שם המערכת של האוביקט נוכל להחליף אותו בכתובת ה-URL במקום {record}, נעבור לתוכנת Postman שם נזין את כתובת ה URL.



לכל פעולה יש מתודה שמתאימה לה, את המתודה נבחר דרך לחיצה על החץ ליד ה GET מצד שמאל.



נכניס את כתובת ה URL ונחליף את הפרמטרים עם שמות המערכת והמזהה של הרשומה. נלחץ על "Headers" שם נזין את ה TokenID שהעתקנו מהמערכת תחת ממשקי אינטרנט. בשדה השמאלי במקום Key נרשום את ה Token, ובשדה הימיני במקום value נדביק את המזהה.



לאחר מכן נלחץ על Body, נבחר את הפורמט של השאילתה נסמן בעיגול את raw
ונבחר JSON (application/json).



עד כאן למדנו הגדרות בסיסיות כדי להתחיל להשתמש ב Rest API

 

יצירת רשומה

ניתן ליצור רשומה דרך התממשקות ל API של מערכת Powerlink להגדרות שימוש ב HTTP REST API לחצו כאן

יצירת רשומה חדשה מתבצעת דרך :

 

URL

Method

Action

https://api.powerlink.co.il/api/record/{record}

POST

Create


את ה {record} נחליף בשם המערכת של האוביקט בו נרצה ליצור רשומה חדשה.
בגוף השאילתה נרשום ב JSON את הערכים והשדות של הרשומה החדשה.
כדי למצוא את שמות המערכת של השדות נוכל להכנס למצב עריכת רשומה דרך גלגל השיניים האפור הקטן ליד כל טופס >> נלחץ על גלגל השיניים הכחול ליד כל שדה ונראה את שם המערכת.
לדוגמא "שם לקוח" באוביקט לקוחות נקרא accountname

 

מבנה גוף השאילתה:

{
Accountname : "Yossii",
Telephone1 : "0528896656",
Emailaddress1 : "support@powerlink.co.il",
 Originatingleadcode : "3",
}

 

נפתח סוגרים מסולסלים { } בתוכם נזין בכל שורה שם מערכת של השדה ואת הערך שנרצה ליצור. במידה ונרצה להוסיף יותר משדה אחד, נפריד בין השדות והערכים בפסיק.



לאחר שנריץ את השאילתה נקבל הודעה על הצלחה, ההודעה תיהיה בפורמט JSON ותכיל את פרטי הרשומה, דוגמה לתשובה של השרת לאחר הצלחה:
* שימו לב לערכים המסומנים בצהוב אלו אותם ערכים שהכנסנו בגוף השאילתה.
* השדות שלא נכללו בשאילתה קיבלו את ערכי ברירת המחדל במערכת או נשארו ריקים (null).

 

{

 "success": true,

 "data": {

   "Record": {

     "telephone1": "0528896656",

     "createdby": "5e7066e9-7051-46a9-8408-2486e03321b5",

     "revenue": null,

     "accountnumber": "1675",

     "statecode": 1,

     "billingcountry": null,

     "modifiedon": "2016-09-18T11:49:05",

     "isvalidforemailcode": 1,

     "ownerid": "5e7066e9-7051-46a9-8408-2486e03321b5",

     "primarycontactid": null,

     "lastactionid": null,

     "shippingcity": null,

     "shippingcountry": null,

     "modifiedby": "5e7066e9-7051-46a9-8408-2486e03321b5",

     "numberofemployees": null,

     "accountid": "23831cc4-077a-4bd2-8182-2c1f7bd16707",

     "shippingstreet": null,

     "fax1": null,

     "emailaddress1": "support@powerlink.co.il",

     "emailaddress3": null,

     "leadid": null,

     "categorycode": null,

     "industrycode": null,

     "telephone3": null,

     "idnumber": null,

     "telephone2": null,

     "parentaccountid": null,

     "shippingzipcode": null,

     "duplicaterecordcode": 1,

     "campaignid": null,

     "accountname": "yossi",

     "billingcity": null,

     "shippingmethodcode": null,

     "websiteurl": null,

     "secondcategorycode": null,

     "originatingleadcode": 3,

     "billingstate": null,

     "paymenttermscode": 0,

     "description": null,

     "shippingstate": null,

     "createdon": "2016-09-18T11:49:05",

     "businesstypecode": null,
     "lastactiontypecode": null,

     "billingzipcode": null,

     "billingstreet": null,

     "emailaddress2": null,

     "lastactiondate": null,

     "accounttypecode": 0,

     "statuscode": 9,

     "accountratingcode": 0,

     "lastactiontitle": null,

     "createdbyname": "עסק בע\"מ",

     "ownername": "עסק בע\"מ",

     "primarycontactname": null,

     "modifiedbyname": "עסק בע\"מ",

     "leadidname": null,

     "parentaccountname": null,

     "campaignname": null,

   }

 },

 "message": ""

}

עדכון רשומה 


ניתן לעדכן רשומה דרך ממשק ה API של מערכת Powerlink  להגדרות ראשוניות לחצו כאן

 

עדכון רשומה מתבצע דרך:
 

URL

Method

Action

https://api.powerlink.co.il/api/record/{record}/{id}

PUT

Update


מבנה גוף השאילתה:

{
“accountname” : “Arik”,
“telephone1” : “0528896656”,
“emailaddress1” : “support@powerlink.co.il”,
“originatingleadcode” : “3”
}

 

במידה והעדכון הצליח נקבל הודעה המכילה הודעת הצלחה ואת ה Id של הרשומה שעדכנו:

{
  "success": true,
  "data": "bfd35ff8-900e-407b-a935-8dd29522ecad",
  "message": ""
}


 

את ה {record} נחליף בשם המערכת של האוביקט בו נרצה ליצור רשומה חדשה.
את ה {id} נחליף ב id של הרשומה אותה נרצה לעדכן, נוכל לקבל את ה id על ידי שאילתה ואיתור  ה id

או ישירות לאחר יצירת רשומה.

דוגמה ל id תקין: e0dd456d-3577-489b-9af8-02c70ba1c8f4


בגוף השאילתה נפתח סוגרים מסולסלים { } בתוכם נזין בכל שורה שם מערכת של השדה ואת הערך שנרצה להזין. במידה ונרצה להוסיף יותר משדה אחד, נפריד בין השדות והערכים בפסיק.

לפני ההרצה חשוב לוודא שהמתודה שבחרנו הינה PUT

 

 
 

מחיקת רשומה דרך API
 

ניתן למחוק רשומה דרך ממשק ה API של מערכת Powerlink  להגדרות ראשוניות לחצו כאן


מחיקת רשומה מתבצעת דרך:
 

URL

Method

Action

https://api.powerlink.co.il/api/record/{record}/{id}

DELETE

Delete



את ה {record} נחליף בשם המערכת של האוביקט בו נרצה לבצע מחיקת רשומה.
את ה {id} נחליף ב id של הרשומה אותה נרצה למחוק.

את ה id ניתן לקבל לאחר יצירת רשומה ב Create או לאחר הרצת שאילתת Query וקבלת ה id של הרשומה.

בגוף השאילתה אין צורך לרשום מידע נוסף.
לפני ההרצה חשוב לוודא שהמתודה שבחרנו הינה DELETE


 

לבסוף נקבל הודעה על הצלחת מחיקת הרשומה:

 

}
  "success": true,
  "data": null,
  "message": ""
{
 
 
 
 

שאילתה דרך API
 

ניתן לשלוף נתונים דרך ממשק ה API של מערכת Powerlink  

 

 

שליפת נתונים מתבצעת דרך:
 

URL

Method

Action

https://api.powerlink.co.il/api/query

POST

Query


נוכל לבצע שאילתות במערכת לקבלת רשומות לפי חיתוכים וסינונים, נוכל לבצע שאילתה לקבל לקוח ספציפי כדי שנוכל להמשיך לבצע עליו פעולות (עדכון, מחיקה).

 

 

דוגמה לשאילתה המביאה לנו 50 תוצאות בדף החל מהדף הראשון והיא תציג לנו שם, טלפון,דוא"ל, וID מתוך אוביקט הלקוחות והיא ממוינת לפי שם הלקוחות בסדר עולה
 


{
  "objecttype": 1,
  "page_size": 50,
  "page_number": 1,
  "fields": "accountname,emailaddress1,telephone1, accountid",
  "query": "(statuscode = 2)",
  "sort_by": "accountname",
  "sort_type": "desc"
}

 

 



יש לוודא שאנו משתמשים במתודה POST
בגוף השאילתה נכתוב מספר פרמטרים:




Example

description

parameter

Account = 1
Task = 10
Contact = 2
Activity = 6

מספר האוביקט עליו נבצע את השאילתה**
הכוונה למספר רשומה  שניתן לראות דרך הגדרת רשומות

objecttype

50

כמות התוצאות בכל שליפה (מקס' 500)

page_size

1

מאיזה עמוד להתחיל למשוך תוצאות

page_number

Fields = “accountname, emailaddress1”

Fields = “*”

אילו שדות לקבל בתוצאות - הפרדה בין שדה לשדה בפסיק.
כדי לקבל את כל השדות ברשומה נרשום כוכבית (*)

fields

Accountname = “yossi”


Statuscode = 7


Telephone1 = “0528896656”

(Accountname = “yossi” ) and (
City = “haifa”)

תוכן השאילתה

(emailaddress1=’amos@ibm.com’ and statuscode = 3) or (statuscode =9)

query

Accountname

Statuscode

לפי איזה שדה למיין את התוצאות

sort_by

 

באיזו צורה לסדר את הרשימה סדר עולה ASC או סדר יורד DESC

sort_type


** את מספר האוביקט ניתן לראות בכתובת ה URL בכניסה לכל אוביקט במערכת אחרי המילה oid לדוגמא :
https://secure.powerlink.co.il/_common/viewrecord.aspx?oid=1


 
 
 
עוד מאמרים בנושא API:  יצירת קבלה, יצירת חשבונית מס/קבלה

כניסה ל-GitHub להסברים נוספים

 
 
 

דוגמה לשאילתה המביאה לנו 50 תוצאות בדף החל מהדף הראשון והיא תציג לנו שם, טלפון,דוא"ל, וID מתוך אוביקט הלקוחות והיא ממוינת לפי שם הלקוחות בסדר עולה
 


{

 "objecttype": 1,

 "page_size": 50,

 "page_number": 1,

 "fields": "accountname,emailaddress1,telephone1, accountid",

 "query": "(statuscode = 2)",

 "sort_by": "accountname",

 "sort_type": "desc"

}