डेवलपर एकीकरण

7stamp REST API

उपलब्ध

7stamp Integration API एक CRM, ईकॉमर्स प्लेटफ़ॉर्म, POS, कस्टम बैकएंड, या ऑटोमेशन टूल को आपके स्वयं के सिस्टम द्वारा पहले से उपयोग किए जाने वाले संपर्क पहचानकर्ता के साथ वॉलेट लॉयल्टी कार्ड प्रबंधित करने देता है। जब कोई विशेष एकीकरण मौजूद नहीं होता है तो यह सार्वभौमिक विकल्प है।

API आधार URL https://api.7loc.com/cards-api. है प्रत्येक अनुरोध को Bearer टोकन के रूप में API कुंजी के साथ प्रमाणित करें। उत्पादन तर्क बनाने से पहले लाइव अनुरोध और प्रतिक्रिया स्कीमा के लिए लिंक किए गए OpenAPI संदर्भ का उपयोग करें।

आप API

के साथ क्या कर सकते हैं API एकीकरण स्टैक का लेखन पक्ष है। जब भी आपका अपना सॉफ़्टवेयर सत्य का परिचालन स्रोत बना रहे, तब इसका उपयोग करें जबकि 7stamp वॉलेट लॉयल्टी परत को संभालता है।

अपने स्वयं के सॉफ़्टवेयर से कार्ड जारी करें

अपने सिस्टम में किसी भी ग्राहक के लिए एक व्यक्तिगत वॉलेट कार्ड लिंक जेनरेट करें। इसे अपने स्वयं के ईमेल, SMS, पुश, या इन-ऐप फ़्लो के माध्यम से वितरित करें। ग्राहक लिंक खोलता है और कार्ड को Apple Wallet या Google Wallet पर सहेजता है।

किसी भी स्रोत से क्रेडिट स्टैम्प

जब आपके कस्टम POS में कोई खरीदारी बंद हो जाती है, जब आपकी वेबसाइट पर ऑनलाइन ऑर्डर का भुगतान किया जाता है, या जब आपके बुकिंग सिस्टम में कोई सेवा पूरी हो जाती है, तो क्रेडिट स्टैम्प के लिए API पर कॉल करें। कार्ड कुछ ही सेकंड में अपडेट हो जाता है.

वाउचर और अभियान प्रबंधित करें

किसी विशिष्ट ग्राहक को एकमुश्त वाउचर जारी करें, अभियान-तैयार इनाम प्रवाह बनाएं, और वाउचर स्थिति को उन प्रणालियों में वापस खींचें जो वित्त और सेवा की गुणवत्ता को संभालते हैं।

प्रलेखित एकीकरण API संचालन

Make और Zapier कार्यों के पीछे ये सार्वजनिक API मार्ग हैं। 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 और एकीकरण खोलें, एक कुंजी जोड़ें, फिर इसे एक सुरक्षित सर्वर-साइड सीक्रेट या ऑटोमेशन कनेक्शन में कॉपी करें।

7stamp Admin API और एकीकरण स्क्रीन Add API Key बटन दिखा रही है और जेनरेट API कुंजी संवाद
चरण 1 - बाएं नेविगेशन में API और एकीकरण का चयन करें, खोलें API Keys, Add API Key चुनें, उपयुक्त स्टाफ लॉगिन का चयन करें, और कुंजी उत्पन्न करें।
7stamp Admin संवाद एक नव निर्मित API कुंजी और उसका प्रतिलिपि नियंत्रण दिखा रहा है
चरण 2 - नई कुंजी को पासवर्ड मैनेजर, सर्वर-साइड सीक्रेट, या सुरक्षित Make/Zapier कनेक्शन में कॉपी करें। इसे सोर्स कोड, ब्राउज़र एप्लिकेशन या सपोर्ट टिकट में पेस्ट न करें।

कोडिंग से पहले लेने वाले तीन निर्णय

API कुंजी स्कोप

API Integrations → API KeysAdd API Key के अंतर्गत 7stamp Admin में कुंजी बनाएं। एक कुंजी एक कार्यस्थल की होती है/profile, इसलिए जब आपका खाता सेटअप इसकी अनुमति देता है तो विकास और उत्पादन के लिए अलग-अलग कुंजी बनाएं। यदि कोई रहस्य उजागर हो तो डैशबोर्ड से पहुंच घुमाएं या रद्द करें।

ग्राहक पहचान

External ID आपके सिस्टम से स्थिर संपर्क पहचानकर्ता है: एक CRM ID, ग्राहक UUID, फ़ोन नंबर, या ईमेल। एक अपरिवर्तनीय प्रणाली को प्राथमिकता दें ID। सिस्टम में टकराव से बचने और वेबहुक सहसंबंध को स्पष्ट करने के लिए वैकल्पिक रूप से External Source जोड़ें।

टेम्पलेट चयन

जब प्रोफ़ाइल में एक सक्रिय टेम्पलेट होता है, तो template_id को छोड़ा जा सकता है और 7stamp इसे स्वचालित रूप से चुनता है। जब इसमें एकाधिक सक्रिय टेम्पलेट हों, तो इच्छित template_id पास करें। अनुमानित ID को हार्ड-कोड करने के बजाय पहले GET /templates पढ़ें।

न्यूनतम प्रमाणित अनुरोध: एक आमंत्रण बनाएं

इसे अपने स्वचालन चरण में कॉपी करें 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 चुनें। क्रिएट, स्कैन, लुकअप और वेबहुक लॉजिक में बिल्कुल समान पहचान जोड़ी का उपयोग करें।

05

डिस्पोजेबल परीक्षण संपर्क के साथ POST /cards/invite पर कॉल करें। वास्तविक ग्राहकों को डिलीवरी स्वचालित करने से पहले लौटाए गए इंस्टॉल URL को सत्यापित करें।

06

POST /cards/scan, वाउचर, या संदेश क्रियाएं तभी जोड़ें जब आपके पास अपने बैकएंड में लॉगिंग, त्रुटि प्रबंधन और एक सुरक्षित पुनः प्रयास/idempotency रणनीति हो।

अनुबंध के रूप में API संदर्भ का उपयोग करें

सार्वजनिक Swagger/OpenAPI संदर्भ में वर्तमान समापन बिंदु, पैरामीटर, अनुरोध-निकाय, प्रतिक्रिया और वेबहुक स्कीमा शामिल हैं। इंटरैक्टिव URL https://api.7loc.com/cards-api/docs है और मशीन-पठनीय अनुबंध https://api.7loc.com/cards-api/openapi.json. है त्रुटि प्रबंधन को लागू करने या वैकल्पिक फ़ील्ड जोड़ने से पहले इसे पढ़ें।

प्रमाणीकरण और कुंजी सुरक्षा

कुंजी एक सर्वर-साइड रहस्य है. इसे ब्राउज़र जावास्क्रिप्ट, मोबाइल ऐप बंडल, सार्वजनिक फ़ॉर्म, स्क्रीनशॉट, 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 को कब हटा सकता हूँ?

केवल तभी जब कनेक्टेड प्रोफ़ाइल में बिल्कुल एक सक्रिय कार्ड टेम्पलेट हो। यदि एकाधिक टेम्पलेट सक्रिय हैं, तो GET /templates.

Should I use the API, Make, or Zapier?

कस्टम POS, बैकएंड, साइट या पूर्ण नियंत्रण के लिए API का उपयोग करें। विज़ुअल ब्रांचिंग परिदृश्यों के लिए Make का उपयोग करें। अधिकतर रैखिक ट्रिगर-एक्शन वर्कफ़्लो के लिए Zapier का उपयोग करें। तीनों एक ही API कुंजी और API अनुबंध पर भरोसा करते हैं।

अगला चरण

सबसे छोटे सुरक्षित का परीक्षण करें API प्रवाह पहले

कुंजी बनाएं, GET /templates पर कॉल करें, डिस्पोजेबल संपर्क के लिए एक आमंत्रण बनाएं, फिर सिद्ध अनुरोध के आसपास उत्पादन रहस्य, लॉगिंग, पुनः प्रयास और वेबहुक हैंडलिंग जोड़ें।