התממשקות למערכות API

HTTP

קיצור של Hypertext Transfer Protocol, שהוא פרוטוקול תקשורת המשמש לשליחה וקבלה של דפים באינטרנט ב port 80.

ה HTTP משתמש ב user agent על מנת לתקשר מול שרת.  user agent יכול להיות דפדפן, שירות או תוכנה (כגון Insomnia) והשרות או אתר איתו מתקשרים מוכרח להיות בכתובת URL או URI כגון:

http://

HTTPS

stocks 3334074 640 300x228 - התממשקות למערכות API
אוטומציה

קיצור של Hypertext Transfer Protocol Secure היא גרסא מאובטחת יותר של פרוטוקול HTTP. בקשות מסוג זה נשלחות בצורה הבאה:

https://

הפרוטוקול הזה מקודד (Enrcypt) את המידע שנשלח ומתקבל ויכול למנוע מהאקרים לבצע פעולות זדוניות כגון גניבת מידע ובד”כ משומש על מנת לאבטח תהליכי תשלום מכוון. HTTPS  משתמש ב port 443 לשליחת המידע.

בקשות HTTP

בקשת HTTP יכולה להיות טעינה של כתובת אתר (כגון YNET) או קריאה לכתובת על מנת לקבל מידע ברמת השרת (כמו בדיקת מזג אויר על מנת לשלוח מייל המפרסם מטריות).

סוגי בקשות HTTP

  • GET – מבקשת מהשרת לאחזר משאב
  • POST – מבקשת מהשרת לייצר משאב חדש
  • PUT – מבקש מהשרת לעדכן\לערוך משאב קיים
  • DELETE – מבקש מהשרת למחוק משאב

דוגמאות לבקשות HTTP מסוג GET

  • בדיקה האם מייל קיים ברשימת דיוור במערכת כגון רב מסר.
  • בדיקת מיקום על פי כתובת IP.
  • משיכת מזהה מערכת של לקוח במערכת CRM.

דוגמאות לבקשות HTTP מסוג POST

  • הוספת נמען לרשימת דיוור ברב מסר.
  • יצירת לקוח פוטנציאלי חדש במערכת CRM.
  • שליחת הודעת SMS.
  • הפקת חשבונית.
13914978085ae4238a4eba06.62726754 shutterstock 320871536 300x220 - התממשקות למערכות API
אוטומציה לעסק

דוגמאות לבקשות HTTP מסוג PUT

  • עדכון מספר טלפון של לקוח במערכת CRM.
  • שינוי סטטוס לקוח למשלם במערכת CRM.

דוגמאות לבקשות HTTP מסוג DELETE

  • מחיקת נמען מרשימת דיוור ברב מסר.
  • מחיקת לקוח ממערכת CRM.
  • מחיקת מידע ממסד נתונים.

קריאת מסמכי API

מה עלינו לדעת לפני שאנו רוצים לשלוח בקשה ל API דרך Webhook by Zapier:

  • באיזו מתודה עלינו להשתמש (post/get)
  • אילו פרמטרים עלינו לשלוח
  • מה הפורמט המבוקש לשליחת המידע
  • מיפוי השדות, מה חובה ומה רשות
  • האם יש אותנטיקציה כלשהי
שינוי גודל פונט
הפעל ניגודיות