חברו את הכלים שלכם להזמנות, למלאי הזמין ולמעקב אחר משלוחים באמצעות REST API, TypeScript SDK ו-webhooks.
פתחו את פורטל המפתחים כדי לראות לאילו ממשקי API החשבון שלכם מורשה לגשת ואיזה SDK זמין בסביבה שלכם. נדרשים כניסה לחשבון וההרשאות המתאימות.
ערכת TypeScript SDK
דוגמת TypeScript בצד השרת המשתמשת בלקוח העסקי של Ysend. הגדירו את כתובת הבסיס של ה-API שסוכמה בתהליך ההצטרפות ושמרו את מפתח ה-API במשתני הסביבה של השרת.
import { Ysend } from "@ysend/sdk";
const ysend = new Ysend({
baseUrl: process.env.YSEND_API_BASE_URL!,
apiKey: process.env.YSEND_API_KEY!,
});
const stock = await ysend.inventory.listBalances({ page: 1, pageSize: 20 });
const orders = await ysend.orders.list({ status: "Open", page: 1, pageSize: 20 });
const shipments = await ysend.shipments.list({ page: 1, pageSize: 20 });הדוגמה מחייבת inventory:read, orders:read ו-shipments:read. לפעולות כתיבה באמצעות SDK, ספקו Idempotency-Key קבוע כדי לאפשר ניסיונות חוזרים בלי ליצור פעולה נוספת.
השתמשו ב-Node.js 20 או בגרסה חדשה יותר. אם הפורטל מציע SDK, רשמו את הגרסה ואת שם הקובץ, ואז בדקו את ערך ה-SHA-256 של הקובץ שהורדתם. החליפו את PACKAGE_FILE.tgz בהמשך בשם הקובץ המדויק.
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL חייב להכיל את כתובת המקור של ה-API שסוכמה: פרוטוקול HTTPS ושם המארח, ללא /api/v1. ה-SDK מוסיף את הנתיב הזה. שמרו את YSEND_API_KEY בשרת; הבקשות משתמשות ב-X-Api-Key.
כל קריאה לרשימה מחזירה עמוד אחד. הגדירו page ו-pageSize, ולאחר מכן בדקו את items, totalCount, page ו-pageSize כשהם מסופקים, לפני בקשת עמודים נוספים. העמוד הראשון אינו ייצוא מלא.
YsendError מציג את קוד מצב ה-HTTP, את detail ואת traceId הזמינים. YsendTransportError פירושו שלא התקבלה תגובה שניתן להשתמש בה; במקרה כזה ייתכן שתוצאת פעולת כתיבה אינה ידועה.
ברירת המחדל: שלושה ניסיונות בסך הכול והמתנה של 30 שניות לכותרות התגובה בכל ניסיון. ניתן לנסות שוב בקשות GET/HEAD ובקשות עם Idempotency-Key לאחר שגיאת רשת או מצב HTTP 429, 502, 503 או 504. השתמשו באותו מפתח לאותה פעולה. orders.list משתמש ב-POST ללא המפתח הזה, ולכן אינו מקבל את הניסיונות החוזרים האוטומטיים האלה.
תארו את הכלים שלכם ואת הנתונים שברצונכם להחליף בפניית האינטגרציה. הצוות שלנו יעזור לזהות את תיעוד ה-API, ה-SDK והרשאות הגישה המתאימים לארגון שלכם. אל תצרפו סודות או מפתחות סודיים.
מתחילים
לאחר הפעלת החשבון, מנהל מורשה יוצר מפתח עם ההרשאות הדרושות לאינטגרציה שלכם.
אם פורסמה חבילת SDK לסביבה שלכם, הורידו אותה מפורטל המפתחים, בדקו את ערך ה-SHA-256 והתקינו את הקובץ שהורדתם.
קראו נתוני מלאי, הזמנות ומשלוחים בהתאם להרשאות שהוקצו למפתח שלכם.
התראות webhooks
צרו מנויים ביישום האינטרנט, בדקו אותם באמצעות ping ועיינו בניסיונות המסירה. תור ההודעות היוצאות מנסה שוב כשלים המתאימים לניסיון חוזר; אירועים שמיצו את מספר הניסיונות נשארים גלויים בתור ההודעות שלא נמסרו.
היקף האינטגרציה
ייבאו CSV או שורות מובנות; בדקו, תקנו ושלחו מחדש שורות שנדחו.
מפו קודי SKU וקראו את המלאי הקיים, השמור והזמין.
הכינו תוכניות קבלה, הוסיפו שורות, בקשו חלונות זמן למסירה ועקבו אחר פערים בקבלה.
קראו את פרטי המוביל, המעקב ומצב המסירה לאחר שתהליך הכנת ההזמנה יוצר את המשלוח.
פתחו תיק המקושר להזמנה וצרפו תמונות או מסמכים.
קראו מנויים והיסטוריית מסירות מתוך האינטגרציה שלכם.
מפתחות לשותפים
שמרו את המפתחות בשרת שלכם. הרשאות החשבון והשותף מגדירות כל פעולה; מנהלים מורשים יוצרים ומחליפים מפתחות ומגדירים webhooks בפורטל המתאים.
הכינו תיאור של זרימת הנתונים ושל הפעולות הדרושות. נאשר את הגישה לחשבון, את תחומי ההרשאה ואת חבילת ה-SDK לאינטגרציה שלכם.
צוות Ysend עוזר לכם לבחור את השירותים, החיבורים ותוכנית ההטמעה המתאימים לעסק שלכם.