تكامل المطور

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 والتكاملات، وأضف مفتاحًا، ثم انسخه إلى اتصال آمن أو اتصال تلقائي من جانب الخادم.

7stamp Admin API شاشة عمليات التكامل تعرض الزر Add API Key وإنشاء API مربع الحوار الرئيسي
الخطوة 1 - حدد API وعمليات التكامل في شريط التنقل الأيسر، افتح API Keys، اختر Add API Key، حدد تسجيل دخول الموظفين المناسب، وقم بإنشاء المفتاح.
7stamp Admin مربع حوار يعرض مفتاح API الذي تم إنشاؤه حديثًا والتحكم في نسخه
الخطوة 2 - انسخ المفتاح الجديد إلى مدير كلمات المرور أو سر من جانب الخادم أو اتصال Make/Zapier الآمن. لا تلصقه في التعليمات البرمجية المصدر، أو تطبيق المتصفح، أو تذكرة الدعم.

ثلاثة قرارات يجب اتخاذها قبل البرمجة

API نطاق المفتاح

أنشئ المفتاح في 7stamp Admin تحت API Integrations → API KeysAdd API Key. المفتاح ينتمي إلى مكان عمل واحد/profile، لذا قم بإنشاء مفاتيح منفصلة للتطوير والإنتاج عندما يسمح إعداد حسابك بذلك. قم بتدوير أو إلغاء الوصول من لوحة المعلومات إذا تم كشف سر ما.

هوية العميل

External ID هو معرف جهة الاتصال الثابت من نظامك: CRM ID، العميل UUID، رقم الهاتف، أو البريد الإلكتروني. تفضل نظام غير قابل للتغيير ID. قم بإضافة External Source بشكل اختياري لتجنب الاصطدامات عبر الأنظمة ولتوضيح ارتباط خطاف الويب.

اختيار القالب

عندما يكون للملف الشخصي قالب نشط واحد، يمكن حذف 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 من نظامك الخاص. استخدم نفس زوج الهوية بالضبط في منطق الإنشاء والمسح والبحث والربط على الويب.

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. اقرأه قبل تنفيذ معالجة الأخطاء أو إضافة حقول اختيارية.

المصادقة والسلامة الرئيسية

المفتاح هو سر من جانب الخادم. لا تعرضه في متصفح 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، وأنشئ دعوة واحدة لجهة اتصال يمكن التخلص منها، ثم أضف أسرار الإنتاج، والتسجيل، وإعادة المحاولة، والتعامل مع خطاف الويب حول الطلب المثبت.