ניתן לעיין בפרטי ה-API בתיעוד API של Swagger
מבוא ל-APIs
ה-API של שיג ושיח משמש לאחזור נתונים מהתהליך שנבנה. להלן מספר דוגמאות למה שניתן לעשות עם ה-API של שיג ושיח.
משיכת התהליך שנבנה משיג ושיח.
יצירה, מחיקה או קבלת נתונים כולל תג תהליך, שדה תהליך.
טיפול בנתונים על המנויים, כולל קבלת מידע על המנויים, עריכת התג או השדה שלהם וכן תת-התהליך שנשלח למנויים.
הגדרת כל הנתונים המשמשים במסחר אלקטרוני כגון סלי קניות או מוצרים.
אם יש צורך לטפל בנתונים הבאים, הסעיפים הבאים יציגו את השלבים לשימוש ב-API של שיג ושיח.
אימות
מכיוון שהגנה על הנתונים חשובה ל-API, יש צורך להשתמש במספר תכונות לאימות הזהות. לכן, השלב הראשון הוא הזנת פרטי האימות. יש ללחוץ על כפתור Authorize, כפי שמוצג באיור הבא.
לאחר מכן, ישנן שלוש תכונות שיש למלא בתיבת הטקסט.
להלן הדרכים למצוא תכונות אלו בסעיף הבא.
יצירת API Key (http,Bearer)
שלב 1 לאחר התחברות לחשבון בשיג ושיח, בפינה הימנית העליונה יוצג שם החשבון והאווטאר. יש ללחוץ עליו ולבחור ב-Your Settings (ההגדרות שלך) ברשימה הנפתחת.
שלב 2 מעבר ל-API Keys Section (מדור מפתחות API) על ידי לחיצה על הכפתור בהגדרות המשתמש. יש להזין את שם המפתח הרצוי וללחוץ על Create button (כפתור יצירה).
שלב 3 לאחר מכן יתקבל המפתח בחלון קופץ.
אזהרה - זהו מפתח ה-API החדש. זו הפעם היחידה שהמפתח יוצג, לכן חשוב לא לאבד אותו! ניתן לבטל את המפתח בכל עת מהגדרות ה-API.
בסגירת החלון יתקבל המידע הבסיסי על המפתח למעט ערך המפתח.
קבלת ה-Curl וכתובת ה-Request URL
Curl משמש בבקשות API. בתיעוד ה-API של שיג ושיח, יש צורך במספר פעולות לפני קבלת ה-curl בתיעוד ה-API של שיג ושיח.
כאן, נשתמש ב-Get Flow Tag כדוגמה.
שלב 1. יש ללחוץ על הרחבת הפעולה של הקטגוריה, Flow Tag במקרה זה. לאחר מכן יש למצוא את הפעולה והתכונה, Get /flow/tags. יש ללחוץ על השורה ודף ייפתח כפי שמוצג להלן.
שלב 2. סמל זה מציין אימות. אם פעולה זו בוצעה בעבר, שלב זה אינו נדרש. אחרת, יש לבצע את אותן פעולות כפי שהוזכר קודם בסעיף אימות.
שלב 3. יש ללחוץ על Try it out. לאחר מכן ניתן יהיה להזין את חלק הפרמטרים או גוף הבקשה וכפתור Execute יוצג בתחתית חלק זה.
שלב 4. יש להזין את הפרמטרים או גוף הבקשה הנדרשים וללחוץ על כפתור Execute. לבסוף יתקבלו ה-Curl וה-Request URL.
טיפ - יש ללחוץ על כפתור Clear אם יש צורך לאפס את הפרמטרים.
תגובות
חלק זה מציג את תוצאת ה-Json שתתקבל מה-API של שיג ושיח. בדרך כלל אם הקוד הוא 200, המשמעות היא שהתגובה התקבלה בהצלחה. אם הקוד הוא 400, המשמעות היא שיש שגיאה בתגובה.
Example Value / Schema
מלבד ערך לדוגמה, ניתן ללחוץ על "Schema" כדי להציג פרטים נוספים כגון אילו ערכים הם חובה.
ה-API הרשמי של שיג ושיח
ניתן למצוא מידע נוסף על ה-API של שיג ושיח כאן.
ה-API לשותפים של שיג ושיח
אם הצטרפת לתוכנית השותפים של שיג ושיח, ניתן ללמוד עוד על ה-API לשותפים של שיג ושיח.