Tərtibatçı inteqrasiyası

7Stamp REST API

Mövcuddur

7Stamp Integration API CRM, e-ticarət platforması, POS, fərdi arxa hissə və ya avtomatlaşdırma alətinə öz sisteminizin artıq istifadə etdiyi kontakt identifikatoru ilə Wallet sadiqlik kartlarını idarə etməyə imkan verir. Xüsusi inteqrasiya olmadıqda universal seçimdir.

API baza URL https://api.7loc.com/cards-api. hər sorğunu API açarı ilə Bearer nişanı kimi təsdiq edin. İstehsal məntiqini qurmazdan əvvəl canlı sorğu və cavab sxemləri üçün əlaqəli OpenAPI arayışından istifadə edin.

API ilə nə edə bilərsiniz

API inteqrasiya yığınının yazı tərəfidir. 7Stamp Wallet sadiqlik qatını idarə edərkən, öz proqram təminatınız həqiqətin operativ mənbəyi olaraq qaldıqda ondan istifadə edin.

Öz proqram təminatınızdan kartları buraxın

Sisteminizdə istənilən müştəri üçün şəxsi Wallet kartı linki yaradın. Onu öz e-poçtunuz, SMS, push və ya tətbiqdaxili axın vasitəsilə çatdırın. Müştəri linki açır və kartı Apple Wallet və ya Google Wallet-da saxlayır.

İstənilən mənbədən kredit möhürləri

Şəxsi POS alış-verişiniz bağlandıqda, vebsaytınızda onlayn sifariş ödənildikdə və ya sifariş sisteminizdə xidmət tamamlandıqda, möhür vermək üçün API-ni çağırın. Kart saniyələr ərzində yenilənir.

Vauçerləri və kampaniyaları idarə edin

Müəyyən bir müştəriyə birdəfəlik vauçer verin, kampaniyaya hazır mükafat axını yaradın və maliyyə və xidmət keyfiyyətini idarə edən sistemlərə çek statusunu geri çəkin.

Sənədləşdirilmiş İnteqrasiya API əməliyyatları

Bunlar Make və Zapier əməliyyatlarının arxasındakı ictimai API marşrutlarıdır. API arayışında dəqiq sxemi oxuyun; sahə adlarını fərqli son nöqtədən çıxarmayın.

Kartlar POST /cards/invite

Kart dəvəti yaradın

Xarici kontakt üçün yeni şəxsi quraşdırma URL yaradır.

Kartlar POST /cards/invite/bulk

Toplu kart dəvətləri yaradın

Nəzarət olunan topluda 100-ə qədər dəvət linki yaradır.

Kartlar GET /cards

Kartları tapın

Xarici kontakt identifikatoru ilə kart qeydlərinə baxır.

Kartlar GET /cards/{user_card_id}

Kart detallarını əldə edin

Bir kartın tam vəziyyətini daxili 7Stamp ID ilə qaytarır.

Kartlar POST /cards/scan

Kartı skan edin

ID və ya External ID kartları ilə möhürlər əlavə edir və təchiz edildikdə mənbə sifarişini qeyd edir.

Şablonlar GET /templates

Şablonların siyahısı

Açarın iş yerində mövcud olan kart şablonlarını sadalayır/profile.

Şablonlar GET /templates/{template_id}/design

Şablon dizaynını əldə edin

Məlum kart şablonu üçün vizual parametrləri oxuyur.

Çeklər POST /vouchers/issue

Kupon verin

Kart sahibinə çek verir.

Mesajlar POST /messages/send

Mesaj göndər

Kart sahibinə Wallet kartı push bildirişi və/və ya e-poçt vasitəsilə məzmun göndərir.

API açarını harada yaratmaq və kopyalamaq olar

Bunlar real 7Stamp Admin ekranlardır. API & İnteqrasiyaları açın, açar əlavə edin, sonra onu təhlükəsiz server tərəfi sirrinə və ya avtomatlaşdırma bağlantısına kopyalayın.

7Stamp Admin API & Add API Key düyməsini və Yaradın API Açar dialoqunu göstərən API & İnteqrasiya ekranı
Addım 1 — Sol və 30-da ⟦30-i seçin naviqasiya, API Keys açın, Add API Key seçin, müvafiq işçi girişini seçin və açarı yaradın.
7Stamp Admin yeni yaradılmış API açarı və onun surətinə nəzarəti göstərən dialoq qutusu
Addım 2 — Yeni açarı parol menecerinə, server sirrinə və ya təhlükəsiz ⟦36309⟦36309 bağlantısına kopyalayın. Onu mənbə koduna, brauzer proqramına və ya dəstək biletinə yapışdırmayın.

Kodlaşdırmadan əvvəl veriləcək üç qərar

API əsas əhatə dairəsi

API Integrations → API Keys → Add API Key altında 7Stamp Admin-də açar yaradın. Açar bir iş yerinə aiddir/profile, ona görə də hesab quraşdırmanız icazə verdikdə inkişaf və istehsal üçün ayrıca açarlar yaradın. Sirr ifşa olunarsa, idarə panelindən girişi döndərin və ya ləğv edin.

Müştəri şəxsiyyəti

External ID sisteminizdən sabit kontakt identifikatorudur: CRM ID, müştəri UUID-si, telefon nömrəsi və ya e-poçt ünvanı. Dəyişməz sistem ID-sinə üstünlük verin. Sistemlər arasında toqquşmaların qarşısını almaq və webhook korrelyasiyasını aydın etmək üçün istəyə görə External Source əlavə edin.

Şablon seçimi

Profildə bir aktiv şablon olduqda, template_id buraxıla bilər və 7Stamp onu avtomatik seçir. Onun çoxsaylı aktiv şablonları olduqda, nəzərdə tutulan template_id-i keçin. Əvvəlcə GET /templates oxuyun, təxmin edilən ID-u çətin kodlaşdırmaqdansa.

Minimal doğrulanmış sorğu: dəvət yaradın

Bunu avtomatlaşdırma addımınıza kopyalayın 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 açarından ilk uğurlu sorğuya

01

7Stamp Admin-ə daxil olun və açar yaradın: API Integrations → API Keys → Add API Key. Onu mənbə kodunda və ya müştəri tərəfindəki tətbiqdə deyil, sirlər menecerində saxlayın.

02

URL bazasını https://api.7loc.com/cards-api olaraq təyin edin və Authorization əlavə edin: Bearer və ardınca hər server tərəfi sorğu üçün açar.

03

Əvvəlcə GET /templates sorğusunu göndərin. Uğurlu cavab tokeni təsdiqləyir və həmin iş yerində/profildə mövcud olan şablonları göstərir.

04

Öz sisteminizdən stabil External ID və isteğe bağlı External Source seçin. Yaratmaq, skan etmək, axtarış etmək və webhook məntiqində eyni şəxsiyyət cütlüyündən istifadə edin.

05

Bir test kontaktı ilə POST /cards/invite sorğusunu göndərin. Real müştərilərə çatdırılmanı avtomatlaşdırmazdan əvvəl qaytarılan quraşdırma URL-ini yoxlayın.

06

POST /cards/scan, çek və ya mesaj əməliyyatlarını yalnız giriş, xətaların idarə edilməsi və öz arxa planınızda təhlükəsiz yenidən cəhd/idempotency strategiyasından sonra əlavə edin.

Müqavilə kimi API arayışından istifadə edin

İctimai Swagger/OpenAPI arayışı cari son nöqtəni, parametri, sorğu gövdəsini, cavabı və veb-qanç sxemlərini ehtiva edir. İnteraktiv URL https://api.7loc.com/cards-api/docs və maşın tərəfindən oxuna bilən müqavilə https://api.7loc.com/cards-api/openapi.json. xətaların idarə edilməsini həyata keçirməzdən və ya əlavə sahələr əlavə etməzdən əvvəl onu oxuyun.

Doğrulama və açarın təhlükəsizliyi

Açar server tərəfi sirridir. Onu JavaScript brauzerində, mobil proqram paketində, ictimai formada, skrinşotlarda, Make/Zapier mətn sahələrində və ya dəstək biletlərində ifşa etməyin. Server, təhlükəsiz avtomatlaşdırma bağlantısı və ya gizli menecerdən istifadə edin. Açar təsadüfən paylaşılıbsa, onu 7Stamp Admin-də ləğv edin və ya fırladın və təsirlənmiş əlaqəni yeniləyin.

Tez-tez verilən suallar

7Stamp API tokenini haradan əldə edə bilərəm?

7Stamp Admin-də API Integrations → API Keys → Add API Key bölməsinə keçin. Token daha sonra Authorization başlığına Bearer və ardınca açar kimi göndərilir.

Əsas URL və autentifikasiya üsulu nədir?

https://api.7loc.com/cards-api istifadə edin və icazə verilən hər sorğuda Authorization: Bearer YOUR_7STAMP_API_KEY göndərin.

template_id-ni nə vaxt göndərməyə bilərəm?

Yalnız qoşulmuş profildə tam olaraq bir aktiv kart şablonu olduqda. Bir neçə şablon aktivdirsə, düzgün template_id seçin GET /templates.

Mən API, Make və ya ⟦2 istifadə etməliyəm?

Fərdi POS, backend, sayt və ya tam nəzarət üçün API istifadə edin. Vizual budaqlanma ssenariləri üçün Make istifadə edin. Əsasən xətti tetikleyici iş axını üçün Zapier istifadə edin. Hər üçü eyni API açarına və API müqaviləsinə əsaslanır.

Növbəti addım

Əvvəlcə ən kiçik seyfi sınayın API axını

Açarı yaradın, GET /templates sorğusunu göndərin, bir test kontaktı üçün dəvət yaradın, sonra yoxlanılmış sorğunun ətrafına istehsal sirlərinin saxlanmasını, loqlaşdırmanı, təkrar cəhdləri və webhook emalını əlavə edin.