Vývojářská integrace

7stamp REST API

K dispozici

7stamp Integration API umožňuje CRM, platformě elektronického obchodu, POS, vlastnímu backendu nebo nástroji pro automatizaci spravovat věrnostní karty peněženky s identifikátorem kontaktu, který již váš systém používá. Je to univerzální možnost, když specializovaná integrace neexistuje.

Základna API URL je https://api.7loc.com/cards-api. Ověření každého požadavku pomocí klíče API jako tokenu Bearer. Před vytvořením produkční logiky použijte propojenou referenci OpenAPI pro živá schémata požadavků a odpovědí.

Co můžete dělat s API

API je zapisovací strana integračního zásobníku. Použijte jej vždy, když by váš vlastní software měl zůstat provozním zdrojem pravdy, zatímco 7stamp zpracovává vrstvu věrnosti peněženky.

Vydávejte karty z vlastního softwaru

Vygenerujte odkaz na kartu osobní peněženky pro každého zákazníka ve vašem systému. Doručte jej prostřednictvím svého vlastního e-mailu, SMS, push nebo v aplikaci. Zákazník otevře odkaz a uloží kartu na číslo Apple Wallet nebo Google Wallet.

Kreditní známky z jakéhokoli zdroje

Když se nákup uzavře ve vašem vlastním POS, když je online objednávka zaplacena na vašem webu nebo když je služba dokončena ve vašem rezervačním systému, zavolejte na API a připište známky. Karta se aktualizuje během několika sekund.

Správa poukazů a kampaní

Vystavte jednorázový poukaz konkrétnímu zákazníkovi, vytvořte toky odměn připravené na kampaň a přetáhněte stav poukazů zpět do systémů, které se starají o finance a kvalitu služeb.

Dokumentovaná integrace API operace ⟦999999 za veřejnými

veřejných ⟧ 9 Make a Zapier akcí. Přečtěte si přesné schéma v odkazu API; neodvozujte názvy polí z jiného koncového bodu.

Karty POST /cards/invite

Vytvořit pozvánku na kartu

Vytvoří novou osobní instalaci URL pro externí kontakt.

Karty POST /cards/invite/bulk

Hromadné vytvoření pozvánek na karty

Vytvoří až 100 odkazů na pozvánky v řízené dávce.

Karty GET /cards

Najít karty

Vyhledá záznamy karet podle externího identifikátoru kontaktu.

Karty GET /cards/{user_card_id}

Získejte podrobnosti o kartě

Vrátí úplný stav jedné karty pomocí jejího interního 7stamp ID.

Karty POST /cards/scan

Naskenujte kartu

Přidá razítka pomocí karty ID nebo External ID a po dodání zaznamená zdrojovou objednávku.

Šablony GET /templates

Seznam šablon

Seznam šablon karet dostupných pro pracoviště klíče/profile.

Šablony GET /templates/{template_id}/design

Získejte návrh šablony

Přečte vizuální nastavení známé šablony karty.

Poukazy POST /vouchers/issue

Vystavit voucher

Vystaví voucher majiteli karty.

Zprávy POST /messages/send

Odeslat zprávu

Odešle obsah peněženky a /or e-mailu vlastníkovi karty.

Kde vytvořit a zkopírovat klíč API

Toto jsou skutečné obrazovky 7stamp Admin. Otevřete API & Integrations, přidejte klíč a zkopírujte jej do zabezpečeného tajného nebo automatizačního připojení na straně serveru.

7stamp Admin API & Obrazovka Integrace zobrazující tlačítko Add API Key a dialog Generovat API Klíč
Krok 1 — Vyberte 31,7 ⟦14 vlevo API Keys, zvolte Add API Key, vyberte příslušné přihlašovací jméno pro zaměstnance a vygenerujte klíč.
7stamp Admin dialog zobrazující nově vygenerovaný klíč API a jeho řízení kopírování
Krok 2 — Zkopírujte nový klíč do správce hesel, tajného klíče na straně serveru nebo zabezpečeného připojení Make2/Make2/⟦ Nevkládejte jej do zdrojového kódu, aplikace prohlížeče nebo lístku podpory.

Tři rozhodnutí, která je třeba učinit před kódováním

API rozsah klíče

Vytvořte klíč v 7stamp Admin pod API Integrations → API KeysAdd API Key. Klíč patří k jednomu pracovišti/profile, takže pokud to nastavení účtu umožňuje, vytvořte samostatné klíče pro vývoj a výrobu. Otočte nebo zrušte přístup z řídicího panelu, pokud je odhalen tajemství.

Identita zákazníka

External ID je stabilní identifikátor kontaktu z vašeho systému: a CRM ID, zákazník UUID, telefonní číslo nebo e-mail. Preferujte neměnný systém ID. Volitelně přidejte External Source, abyste se vyhnuli kolizím mezi systémy a aby byla korelace webhooku explicitní.

Výběr šablony

Když má profil jednu aktivní šablonu, template_id lze vynechat a 7stamp ji vybere automaticky. Pokud má více aktivních šablon, předejte zamýšlené template_id. Nejprve si přečtěte GET /templates místo toho, abyste natvrdo zakódovali uhádnuté ID.

Minimální ověřený požadavek: vytvořte pozvánku

Zkopírujte to do vašeho kroku automatizace 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
  }'

Od klíče API k prvnímu úspěšnému požadavku

01

Přihlaste se k 7stamp Admin a vytvořte klíč: ⟦14323 Uložte jej do svého tajného správce, nikoli do zdrojového kódu nebo do klientské aplikace.

02

Nastavte základ URL na https://api.7loc.com/cards-api a přidejte Authorization: Bearer následovaný klíčem ke každému požadavku na straně serveru.

03

Nejprve zavolejte na číslo GET /templates. Úspěšná odpověď potvrdí token a zobrazí šablony dostupné danému pracovišti/profile.

04

Vyberte si stabilní External ID a volitelný External Source z vašeho vlastního systému. Při vytváření, skenování, vyhledávání a logice webhooku použijte přesně stejný pár identit.

05

Zavolejte POST /cards/invite s jednorázovým testovacím kontaktem. Před automatizací doručení skutečným zákazníkům ověřte vrácenou instalaci URL.

06

Přidejte POST /cards/scan, poukaz nebo akce zpráv až poté, co budete mít protokolování, zpracování chyb a bezpečnou strategii opakování/idempotency ve vašem vlastním backendu.

Použijte odkaz API jako smlouvu

Veřejná reference Swagger/OpenAPI obsahuje aktuální koncový bod, parametr, tělo požadavku, odpověď a schémata webhooku. Interaktivní URL je https://api.7loc.com/cards-api/docs a strojově čitelná smlouva je https://api.7loc.com/cards-api/openapi.json. Přečtěte si ji před implementací zpracování chyb nebo přidáním volitelných polí.

Autentizace a bezpečnost klíče

Klíč je tajemství na straně serveru. Nevystavujte jej v JavaScriptu prohlížeče, balíčku mobilní aplikace, veřejném formuláři, snímcích obrazovky, textových polích Make/Zapier nebo lístcích podpory. Použijte server, zabezpečené automatické připojení nebo správce tajemství. Pokud dojde k náhodnému sdílení klíče, zrušte jej nebo jej otočte v 7stamp Admin a aktualizujte dotčené připojení.

Často kladené otázky

Kde získám token 7stamp API?

V 7stamp Admin přejděte na API Integrations → API Keys → Add API Key. Token je poté odeslán v záhlaví Authorization jako Bearer následovaný klíčem.

Co je základní URL a metoda ověřování?

Použijte https://api.7loc.com/cards-api a odešlete Authorization: Bearer YOUR_7STAMP_API_KEY na každý autorizovaný požadavek.

Kdy mohu vynechat template_id?

Pouze pokud má připojený profil právě jednu aktivní šablonu karty. Pokud je aktivních více šablon, vyberte správnou template_id z GET /templates.

Mám použít API, Make nebo Zapier?

Použijte API pro vlastní POS, backend, web nebo plnou kontrolu. Pro scénáře vizuálního větvení použijte Make. Použijte Zapier pro většinou lineární pracovní postup spouštěcí akce. Všechny tři se spoléhají na stejný klíč API a smlouvu API.

Další krok

Nejprve otestujte nejmenší bezpečný průtok API

Vytvořte klíč, zavolejte na číslo GET /templates, vytvořte jednu pozvánku pro kontakt na jedno použití a poté k osvědčenému požadavku přidejte produkční tajemství, protokolování, opakování a zpracování webhooku.