ادغام توسعه دهندگان

7stamp REST ⟦30463

موجود است

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 & صفحه Integrations که دکمه Add API Key را نشان می‌دهد و گفتگوی کلیدی API ایجاد می‌کند
مرحله 1 - 50 Integration را در سمت چپ ناوبری باز کنید و 5599 را در ناوبری باز کنید. API Keys، Add API Key را انتخاب کنید، ورود کارکنان مناسب را انتخاب کنید و کلید را ایجاد کنید. گفتگوی
7stamp Admin که یک کلید API تازه تولید شده و کنترل کپی آن را نشان می‌دهد
مرحله ۲ — کلید جدید را در یک مدیر رمز عبور، مخفی سمت سرور، یا اتصال امن ⟦3052⦟30573⟧ کپی کنید. آن را در کد منبع، برنامه مرورگر یا بلیط پشتیبانی قرار ندهید.

سه تصمیم باید قبل از کدنویسی بگیرید

API محدوده کلید

کلید را در ⟦30491 در زیر 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 شوید و یک کلید ایجاد کنید: ⟦30575. آن را در مدیر مخفی خود ذخیره کنید، نه کد منبع یا یک برنامه سمت مشتری.

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 را حذف کنم؟

فقط زمانی که نمایه متصل دقیقاً یک الگوی کارت فعال داشته باشد. اگر چندین الگو فعال هستند، template_id صحیح را از GET /templates. انتخاب کنید

آیا باید از API، Make، یا Zapier استفاده کنم؟

از API برای یک POS سفارشی، باطن، سایت یا کنترل کامل استفاده کنید. برای سناریوهای انشعاب بصری از Make استفاده کنید. از Zapier برای یک گردش کار عمدتاً خطی اقدام ماشه ای استفاده کنید. هر سه به یک کلید API و قرارداد API متکی هستند.

مرحله بعدی

ابتدا کوچکترین جریان امن API را آزمایش کنید

کلید را ایجاد کنید، با GET /templates تماس بگیرید، یک دعوت نامه برای یک مخاطب یکبار مصرف ایجاد کنید، سپس اسرار تولید، ثبت گزارش، تلاش مجدد، و رسیدگی به وبقلاب را در مورد درخواست اثبات شده اضافه کنید.