Developer integration

7stamp REST API

זמין

ה-7stamp Integration API מאפשר ל-CRM, פלטפורמת מסחר אלקטרוני, POS, קצה עורפי מותאם אישית, או כלי אוטומציה לנהל כרטיסי נאמנות ארנקים עם מזהה אנשי הקשר שהמערכת שלך כבר משתמשת במזהה שלך. זוהי האפשרות האוניברסלית כאשר אינטגרציה מיוחדת אינה קיימת.

הבסיס API URL הוא https://api.7loc.com/cards-api. אימות כל בקשה עם מפתח API כאסימון Bearer. השתמש בהפניה המקושרת OpenAPI עבור סכימות הבקשות והתגובות בזמן אמת לפני בניית היגיון ייצור.

מה אתה יכול לעשות עם API

ה-API הוא צד הכתיבה של מחסנית האינטגרציה. השתמש בו בכל פעם שהתוכנה שלך צריכה להישאר המקור התפעולי של האמת בעוד 7stamp מטפל בשכבת נאמנות הארנק.

הנפק כרטיסים מהתוכנה שלך

צור קישור לכרטיס ארנק אישי עבור כל לקוח במערכת שלך. שלח אותו באמצעות האימייל שלך, SMS, דחיפה או זרימת אפליקציה. הלקוח פותח את הקישור ושומר את הכרטיס ב-Apple Wallet או Google Wallet.

חותמות אשראי מכל מקור

כאשר נסגרת רכישה ב-POS המותאם אישית שלך, כאשר משלמים הזמנה מקוונת באתר האינטרנט שלך, או כאשר שירות הושלם במערכת ההזמנות שלך, התקשר ל-API כדי לקבל חותמות אשראי. הכרטיס מתעדכן תוך שניות.

נהל שוברים וקמפיינים

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

שילוב מתועד API פעולות

אלו הם המסלולים הציבוריים של API מאחורי הפעולות Make ו-Zapier. קרא את הסכימה המדויקת בהפניה של API; אל תסיק שמות שדות מנקודת קצה אחרת.

כרטיסי POST /cards/invite

צור כרטיס הזמנה

יוצר התקנה אישית חדשה URL עבור איש קשר חיצוני.

כרטיסי POST /cards/invite/bulk

הזמנה ליצירת כרטיס בכמות גדולה

יוצר עד 100 קישורי הזמנה באצווה מבוקרת.

כרטיסי GET /cards

מצא כרטיסים

מחפש רשומות כרטיסים לפי מזהה איש קשר חיצוני.

קלפים GET /cards/{user_card_id}

קבל את פרטי הכרטיס

מחזירה את המצב המלא של כרטיס אחד על ידי 7stamp ID הפנימי שלו.

קלפים POST /cards/scan

סרוק כרטיס

מוסיף חותמות באמצעות כרטיס ID או External ID ומתעד את סדר המקור כאשר הוא מסופק.

תבניות GET /templates

רשימת תבניות

מפרט תבניות כרטיסים הזמינות למקום העבודה של המפתח/profile.

תבניות GET /templates/{template_id}/design

קבל עיצוב תבניות

קורא הגדרות חזותיות עבור תבנית כרטיס ידועה.

שוברים POST /vouchers/issue

הנפק שובר

מנפיק שובר לבעל הכרטיס.

הודעות POST /messages/send

שלח הודעה

שולח תוכן דואר אלקטרוני של ארנק-כרטיס ו-/or לבעל הכרטיס.

היכן ליצור ולהעתיק את מפתח API

אלו מסכי 7stamp Admin אמיתיים. פתח את API & Integrations, הוסף מפתח ולאחר מכן העתק אותו לחיבור סודי או אוטומציה מאובטח בצד השרת. מסך

7stamp Admin API & אינטגרציות המציג את הלחצן Add API Key ויצירת תיבת מפתח API
שלב 1 - בחר API & Integrations בניווט השמאלי, פתח את API Keys, בחר API Keys, בחר את TMXCONST5X המתאים, בחר את המפתח המתאים, בחר את המפתח המתאים, בחר את המפתח המתאים. דו-שיח
7stamp Admin מציג מפתח API שנוצר לאחרונה ובקרת ההעתקה שלו
שלב 2 - העתק את המפתח החדש למנהל סיסמאות, סוד בצד השרת או חיבור Make/Zapier מאובטח. אל תדביק אותו בקוד מקור, ביישום דפדפן או בכרטיס תמיכה.

שלוש החלטות שיש לקבל לפני קידוד

API היקף מפתח

צור את המפתח ב-7stamp Admin תחת API Integrations → API KeysAdd API Key. מפתח שייך למקום עבודה אחד /profile, אז צור מפתחות נפרדים לפיתוח וייצור כאשר הגדרת החשבון שלך מאפשרת זאת. סובב או שלל גישה מלוח המחוונים אם סוד נחשף.

זהות הלקוח

External ID הוא מזהה איש הקשר היציב מהמערכת שלך: CRM ID, לקוח UUID, מספר טלפון או דוא"ל. העדיפו מערכת בלתי ניתנת לשינוי ID. הוסף אופציונלי External Source כדי למנוע התנגשויות בין מערכות וכדי להפוך את מתאם webhook למפורש.

בחירת תבנית

כאשר לפרופיל יש תבנית אחת פעילה, ניתן להשמיט את template_id ו- 7stamp בוחר אותה באופן אוטומטי. כאשר יש לו מספר תבניות פעילות, העבר את ה-template_id המיועד. קרא תחילה את GET /templates במקום בקידוד קשיח של ID מנחש.

בקשה מאומתת מינימלית: צור הזמנה

העתק זאת לשלב האוטומציה שלך bash
curl -X POST "https://api.7loc.com/cards-api/cards/invite" \
  -H "Authorization: Bearer YOUR_7STAMP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "crm_contact_8821",
    "external_source": "hubspot",
    "template_id": 42
  }'

ממפתח API לבקשה מוצלחת ראשונה

01

היכנס ל-7stamp Admin וצור מפתח: API Integrations → API KeysAdd API Key. אחסן אותו במנהל הסודי שלך, לא בקוד המקור או באפליקציה בצד הלקוח.

02

הגדר את הבסיס URL ל-https://api.7loc.com/cards-api והוסף Authorization: Bearer ואחריו המפתח לכל בקשה בצד השרת.

03

התקשר תחילה ל-GET /templates. תגובה מוצלחת מאשרת את האסימון ומציגה את התבניות הזמינות לאותו מקום עבודה /profile.

04

בחר את External ID היציב ואת External Source האופציונלי מהמערכת שלך. השתמש בדיוק באותו זוג זהות בלוגיקה של יצירה, סריקה, חיפוש ו-webhook.

05

התקשר ל-POST /cards/invite עם מגע חד פעמי לבדיקה. אמת את ההתקנה המוחזרת URL לפני אוטומציה של משלוח ללקוחות אמיתיים.

06

הוסף POST /cards/scan, שובר או פעולות הודעה רק לאחר רישום, טיפול בשגיאות ואסטרטגיית ניסיון חוזר בטוחה /idempotency בקצה העורפי שלך.

השתמש בהתייחסות API כחוזה

ההפניה הציבורית Swagger/OpenAPI מכילה את סכימות נקודת הקצה, הפרמטר, גוף הבקשה, התגובה וה-webhook הנוכחיים. ה-URL האינטראקטיבי הוא https://api.7loc.com/cards-api/docs והחוזה הקריא במכונה הוא https://api.7loc.com/cards-api/openapi.json. קרא אותו לפני יישום טיפול בשגיאות או הוספת שדות אופציונליים.

אימות ובטיחות מפתח

המפתח הוא סוד בצד השרת. אל תחשוף אותו ב-JavaScript של הדפדפן, בחבילת אפליקציות לנייד, בטופס ציבורי, בצילומי מסך, בשדות טקסט של Make/Zapier או בכרטיסי תמיכה. השתמש בשרת, בחיבור אוטומציה מאובטח או במנהל סודי. אם המפתח אי פעם שותף בטעות, בטל או סובב אותו ב-7stamp Admin ועדכן את החיבור המושפע.

שאלות נפוצות

היכן אוכל לקבל אסימון 7stamp API?

ב-7stamp Admin, עבור אל API Integrations → API Keys → Add API Key. לאחר מכן האסימון נשלח בכותרת Authorization בתור Bearer ואחריו המפתח.

מהי הבסיס URL ושיטת האימות?

השתמש ב-https://api.7loc.com/cards-api ושלח Authorization: Bearer YOUR_7STAMP_API_KEY על כל בקשה מורשית.

מתי אוכל להשמיט את template_id?

רק כאשר לפרופיל המחובר יש בדיוק תבנית כרטיס פעילה אחת. אם מספר תבניות פעילות, בחר את ה-template_id הנכון מתוך GET /templates.

האם עלי להשתמש ב-API, Make או Zapier?

השתמש ב-API עבור POS מותאם אישית, קצה אחורי, אתר או שליטה מלאה. השתמש ב-Make עבור תרחישי הסתעפות חזותיים. השתמש ב-Zapier עבור זרימת עבודה ליניארית ברובה של פעולת טריגר. שלושתם מסתמכים על אותו מפתח API וחוזה API.

השלב הבא

בדוק תחילה את הזרימה הבטוחה הקטן ביותר של API

צור את המפתח, התקשר ל-GET /templates, צור הזמנה אחת לאיש קשר חד פעמי, ואז הוסף סודות ייצור, רישום, נסיונות חוזרים וטיפול ב-webhook סביב הבקשה המוכחת.