Geliştirici entegrasyonu

7stamp REST API

Mevcut

7stamp Integration API, CRM, e-ticaret platformu, POS, özel arka uç veya otomasyon aracının cüzdanı yönetmesine olanak tanır Kendi sisteminizin zaten kullandığı kişi tanımlayıcıyı içeren sadakat kartları. Özel bir entegrasyonun mevcut olmadığı durumlarda evrensel bir seçenektir.

API tabanı URL https://api.7loc.com/cards-api. Her isteği Bearer belirteci olarak API anahtarıyla doğrulayın. Üretim mantığını oluşturmadan önce canlı istek ve yanıt şemaları için bağlantılı OpenAPI referansını kullanın.

API

ile yapabilecekleriniz API entegrasyon yığınının yazma tarafıdır. 7stamp cüzdan sadakat katmanını yönetirken, kendi yazılımınızın operasyonel gerçek kaynağı olarak kalması gerektiğinde bunu kullanın.

Kartları kendi yazılımınızdan düzenleyin

Sisteminizdeki herhangi bir müşteri için kişisel cüzdan kartı bağlantısı oluşturun. Bunu kendi e-postanız, SMS, push veya uygulama içi akış yoluyla iletin. Müşteri bağlantıyı açar ve kartını Apple Wallet veya Google Wallet adresine kaydeder.

Herhangi bir kaynaktan kredi pulları

Özel POS hesabınızda bir satın alma işlemi kapatıldığında, web sitenizde bir çevrimiçi sipariş ödendiğinde veya rezervasyon sisteminizde bir hizmet tamamlandığında, kredi pulları için API numaralı telefonu arayın. Kart saniyeler içinde güncellenir.

Kuponları ve kampanyaları yönetin

Belirli bir müşteriye tek seferlik kupon düzenleyin, kampanyaya hazır ödül akışları oluşturun ve kupon durumunu finans ve hizmet kalitesini yöneten sistemlere geri çekin.

Belgelenmiş Entegrasyon API işlemler

Bunlar, Make ve Zapier eylemleri. API referansındaki şemanın tamamını okuyun; alan adlarını farklı bir uç noktadan çıkarmayın.

Kartlar POST /cards/invite

Kart daveti oluşturun

Harici bir kişi için yeni bir kişisel kurulum URL oluşturur.

Kartlar POST /cards/invite/bulk

Toplu kart davetleri oluşturma

Kontrollü bir grupta 100'e kadar davet bağlantısı oluşturur.

Kartlar GET /cards

Kartları bul

Harici kişi tanımlayıcısına göre kart kayıtlarını arar.

Kartlar GET /cards/{user_card_id}

Kart detayını al

Dahili 7stamp ID ile bir kartın tam durumunu döndürür.

Kartlar POST /cards/scan

Kart tarayın

Karta ID veya External ID göre damgalar ekler ve sağlandığında kaynak sırasını kaydeder.

Şablonlar GET /templates

Şablonları listele

Anahtarın çalışma alanında kullanılabilen kart şablonlarını listeler/profile.

Şablonlar GET /templates/{template_id}/design

Şablon tasarımını al

Bir anahtar için görsel ayarları okur bilinen kart şablonu.

Kuponlar POST /vouchers/issue

Kupon düzenleyin

Kart sahibine kupon verir.

Mesajlar POST /messages/send

Mesaj gönder

Kart sahibine cüzdan kartı gönderme ve/or e-posta içeriğini gönderir.

API tuşunun oluşturulacağı ve kopyalanacağı yer

Bunlar gerçek 7stamp Admin ekranlardır. API & Entegrasyonlar'ı açın, bir anahtar ekleyin ve ardından onu güvenli bir sunucu tarafı gizli bağlantısına veya otomasyon bağlantısına kopyalayın.

7stamp Admin API Add API Key düğmesini ve Oluştur API Tuş iletişim kutusunu gösteren Entegrasyonlar ekranı
1. Adım — Sol gezinme bölmesinde API & Entegrasyonlar'ı seçin, açın API Keys, Add API Key'yi seçin, uygun personel giriş bilgilerini seçin ve anahtarı oluşturun.
7stamp Admin yeni oluşturulan API anahtarını ve kopya kontrolünü gösteren iletişim kutusu
Adım 2 — Yeni anahtarı bir şifre yöneticisine, sunucu tarafı gizli anahtarına veya güvenli Make/Zapier bağlantısına kopyalayın. Kaynak koduna, tarayıcı uygulamasına veya destek bildirimine yapıştırmayın.

Kodlamadan önce verilmesi gereken üç karar

API anahtar kapsamı

Anahtarı API Integrations → API KeysAdd API Key altında 7stamp Admin'de oluşturun. Anahtar tek bir işyerine aittir/profile, bu nedenle hesap kurulumunuz izin verdiğinde geliştirme ve üretim için ayrı anahtarlar oluşturun. Bir sır açığa çıkarsa kontrol panelinden erişimi değiştirin veya iptal edin.

Müşteri kimliği

External ID, sisteminizdeki sabit iletişim tanımlayıcıdır: a CRM ID, müşteri UUID, telefon numarası veya e-posta. Değişmez bir sistemi tercih edin ID. Sistemler arası çarpışmaları önlemek ve web kancası korelasyonunu açık hale getirmek için isteğe bağlı olarak External Source ekleyin.

Şablon seçimi

Profilde bir etkin şablon olduğunda, template_id atlanabilir ve 7stamp bunu otomatik olarak seçer. Birden fazla etkin şablonu olduğunda amaçlanan template_id'yi iletin. Tahmin edilen bir ID'yi sabit kodlamak yerine ilk önce GET /templates'yi okuyun.

Minimum kimlik doğrulamalı istek: bir davet oluşturun

Bunu otomasyon adı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 anahtarından ilk başarılı isteğe kadar

01

7stamp Admin'de oturum açın ve bir anahtar oluşturun: API Integrations → API KeysAdd API Key. Bunu kaynak kodunda veya istemci tarafı bir uygulamada değil, gizli yöneticinizde saklayın.

02

URL tabanını https://api.7loc.com/cards-api olarak ayarlayın ve her sunucu tarafı isteğine Authorization: Bearer ve ardından anahtarı ekleyin.

03

Önce GET /templates'yi arayın. Başarılı bir yanıt, jetonu onaylar ve o işyeri için mevcut olan şablonları gösterir/profile.

04

Kendi sisteminizden kararlı External ID ve isteğe bağlı External Source'yi seçin. Oluşturma, tarama, arama ve web kancası mantığında tamamen aynı kimlik çiftini kullanın.

05

Tek kullanımlık test kontağı ile POST /cards/invite numaralı telefonu arayın. Gerçek müşterilere teslimatı otomatikleştirmeden önce iade edilen kurulumu URL doğrulayın.

06

POST /cards/scan, kupon veya mesaj eylemlerini yalnızca kendi arka ucunuzda günlüğe kaydetme, hata işleme ve güvenli yeniden deneme/idempotency stratejisine sahip olduktan sonra ekleyin.

Sözleşme olarak API referansını kullanın

Genel Swagger/OpenAPI referansı geçerli uç noktayı, parametreyi, istek gövdesini, yanıtı ve web kancası şemalarını içerir. Etkileşimli URL https://api.7loc.com/cards-api/docs'dir ve makine tarafından okunabilen sözleşme https://api.7loc.com/cards-api/openapi.json. Hata işlemeyi uygulamadan veya isteğe bağlı alanlar eklemeden önce bunu okuyun.

Kimlik doğrulama ve anahtar güvenliği

Anahtar, sunucu tarafında bir sırdır. Bunu tarayıcı JavaScript'inde, mobil uygulama paketinde, herkese açık bir formda, ekran görüntülerinde, Make/Zapier metin alanlarında veya destek bildirimlerinde göstermeyin. Bir sunucu, güvenli otomasyon bağlantısı veya gizli yönetici kullanın. Anahtar yanlışlıkla paylaşılırsa 7stamp Admin'de onu iptal edin veya döndürün ve etkilenen bağlantıyı güncelleyin.

Sıkça sorulan sorular

7stamp API jetonunu nereden alabilirim?

7stamp Admin'de API Integrations → API Keys → Add API Key'ye gidin. Daha sonra jeton Authorization başlığında Bearer olarak ve ardından anahtar gönderilir.

Temel URL ve kimlik doğrulama yöntemi nedir?

Her yetkili istekte https://api.7loc.com/cards-api kullanın ve Authorization: Bearer YOUR_7STAMP_API_KEY'i gönderin.

template_id'yi ne zaman atlayabilirim?

Yalnızca bağlı profilde tam olarak bir etkin kart şablonu olduğunda. Birden fazla şablon etkinse, GET /templates.

Should I use the API, Make, or Zapier?

Özel bir POS, arka uç, site veya tam kontrol için API'yi kullanın. Görsel dallanma senaryoları için Make kullanın. Çoğunlukla doğrusal bir tetikleyici eylem iş akışı için Zapier kullanın. Üçü de aynı API anahtarına ve API sözleşmesine dayanır.

Sonraki adım

Önce en küçük kasa API akışını test edin

Anahtarı oluşturun, GET /templates numaralı telefonu arayın, tek kullanımlık bir kişi için bir davet oluşturun, ardından kanıtlanmış isteğin etrafına üretim sırları, günlük kaydı, yeniden denemeler ve web kancası işleme ekleyin.