Integrácia vývojárov

7stamp REST API

Dostupné

7stamp Integration API umožňuje CRM, platforme elektronického obchodu, POS, vlastnému backendu alebo nástroju na automatizáciu spravovať vernostné karty peňaženky s identifikátorom kontaktu, ktorý už používa váš vlastný systém. Je to univerzálna možnosť, keď špecializovaná integrácia neexistuje.

Základňa API URL je https://api.7loc.com/cards-api. Overte každú požiadavku pomocou kľúča API ako tokenu Bearer. Pred vytvorením produkčnej logiky použite prepojenú referenciu OpenAPI pre živé schémy požiadaviek a odpovedí.

Čo môžete robiť s API

API je zapisovacia strana integračného zásobníka. Použite ho vždy, keď by váš vlastný softvér mal zostať prevádzkovým zdrojom pravdy, zatiaľ čo 7stamp spracováva vernostnú vrstvu peňaženky.

Vydávajte karty z vlastného softvéru

Vytvorte odkaz na kartu osobnej peňaženky pre každého zákazníka vo vašom systéme. Doručte ho prostredníctvom vlastného e-mailu, SMS, push alebo v aplikácii. Zákazník otvorí odkaz a uloží kartu na Apple Wallet alebo Google Wallet.

Kreditné známky z akéhokoľvek zdroja

Keď sa nákup uzavrie vo vašom vlastnom POS, keď je online objednávka zaplatená na vašej webovej stránke, alebo keď je služba dokončená vo vašom rezervačnom systéme, zavolajte na číslo API a pripíšte známky. Karta sa aktualizuje v priebehu niekoľkých sekúnd.

Správa poukážok a kampaní

Vydajte jednorazovú poukážku konkrétnemu zákazníkovi, vytvorte toky odmien pripravených na kampaň a vráťte stav poukážok späť do systémov, ktoré sa zaoberajú financiami a kvalitou služieb.

Zdokumentované integračné operácie API

Toto sú verejné cesty API za akciami Make a Zapier. Prečítajte si presnú schému v odkaze API; neodvodzujte názvy polí z iného koncového bodu.

karty POST /cards/invite

Vytvorte pozvánku na kartu

Vytvorí novú osobnú inštaláciu URL pre externý kontakt.

karty POST /cards/invite/bulk

Hromadné vytváranie pozvánok na karty

Vytvorí až 100 pozývacích odkazov v kontrolovanej dávke.

karty GET /cards

Nájdite karty

Vyhľadáva záznamy kariet podľa externého identifikátora kontaktu.

karty GET /cards/{user_card_id}

Získajte podrobnosti o karte

Vráti úplný stav jednej karty podľa jej interného 7stamp ID.

karty POST /cards/scan

Naskenujte kartu

Pridáva pečiatky pomocou karty ID alebo External ID a po dodaní zaznamená zdrojovú objednávku.

Šablóny GET /templates

Zoznam šablón

Uvádza zoznam šablón kariet dostupných pre pracovisko kľúča/profile.

Šablóny GET /templates/{template_id}/design

Získajte návrh šablóny

Číta vizuálne nastavenia známej šablóny karty.

poukážky POST /vouchers/issue

Vystaviť poukaz

Vystaví poukážku majiteľovi karty.

Správy POST /messages/send

Odoslať správu

Odošle obsah kariet v peňaženke a /or e-mailu majiteľovi karty.

Kde vytvoriť a skopírovať kláves API

Toto sú skutočné obrazovky 7stamp Admin. Otvorte API & Integrations, pridajte kľúč a potom ho skopírujte do zabezpečeného tajného alebo automatického pripojenia na strane servera.

7stamp Admin API & Obrazovka Integrácie zobrazujúca tlačidlo Add API Key a dialógové okno Generovať API Kľúč
Krok 1 — Vyberte ⟧ &4757 v ľavom otvorenom okne⟦ API Keys, vyberte Add API Key, vyberte príslušné prihlásenie personálu a vygenerujte kľúč.
7stamp Admin dialógové okno zobrazujúce novo vygenerovaný kľúč API a jeho kontrolu kopírovania
Krok 2 — Skopírujte nový kľúč do správcu hesiel, tajného servera alebo zabezpečeného pripojenia Make/⟦47. Nevkladajte ho do zdrojového kódu, aplikácie prehliadača alebo lístka podpory.

Tri rozhodnutia, ktoré je potrebné urobiť pred kódovaním

API rozsah kľúča

Vytvorte kľúč v 7stamp Admin pod API Integrations → API KeysAdd API Key. Kľúč patrí k jednému pracovisku/profile, preto si vytvorte samostatné kľúče pre vývoj a výrobu, keď to nastavenie účtu umožňuje. V prípade odhalenia tajomstva otočte alebo zrušte prístup z ovládacieho panela.

Identita zákazníka

External ID je stabilný identifikátor kontaktu z vášho systému: a CRM ID, zákazník UUID, telefónne číslo alebo e-mail. Uprednostňujte nemenný systém ID. Voliteľne pridajte External Source, aby ste sa vyhli kolíziám medzi systémami a aby bola korelácia webhooku explicitná.

Výber šablóny

Keď má profil jednu aktívnu šablónu, template_id možno vynechať a 7stamp ju vyberie automaticky. Keď má viacero aktívnych šablón, odovzdajte zamýšľanú template_id. Najprv si prečítajte GET /templates namiesto toho, aby ste napevno písali uhádnuté ID.

Minimálna overená požiadavka: vytvorte pozvánku

Skopírujte to do svojho kroku automatizácie 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 kľúča API po prvú úspešnú požiadavku

01

Prihláste sa na 7stamp Admin a vytvorte kľúč: API Integrations → API KeysAdd API Key. Uložte ho do svojho tajného správcu, nie do zdrojového kódu alebo aplikácie na strane klienta.

02

Nastavte základňu URL na https://api.7loc.com/cards-api a pridajte Authorization: Bearer nasledovaný kľúčom ku každej požiadavke na strane servera.

03

Najprv zavolajte na číslo GET /templates. Úspešná odpoveď potvrdí token a zobrazí šablóny dostupné pre dané pracovisko/profile.

04

Vyberte si stabilné External ID a voliteľné External Source z vášho vlastného systému. Pri vytváraní, skenovaní, vyhľadávaní a logike webhooku používajte presne rovnaký pár identít.

05

Zavolajte na POST /cards/invite s jednorazovým testovacím kontaktom. Pred automatizáciou doručenia skutočným zákazníkom overte vrátenú inštaláciu URL.

06

Pridajte POST /cards/scan, kupón alebo akcie správy až po protokolovaní, spracovaní chýb a bezpečnom opakovaní/idempotency stratégie vo vašom vlastnom backende.

Použite referenciu API ako zmluvu

Verejná referencia Swagger/OpenAPI obsahuje aktuálny koncový bod, parameter, telo požiadavky, odpoveď a schémy webhooku. Interaktívna URL je https://api.7loc.com/cards-api/docs a strojovo čitateľná zmluva je https://api.7loc.com/cards-api/openapi.json. Prečítajte si ju pred implementáciou spracovania chýb alebo pridaním voliteľných polí.

Autentifikácia a bezpečnosť kľúča

Kľúč je tajomstvo na strane servera. Nezverejňujte ho v JavaScripte prehliadača, balíku mobilnej aplikácie, verejnom formulári, snímkach obrazovky, textových poliach Make/Zapier ani lístkoch podpory. Použite server, zabezpečené automatické pripojenie alebo správcu tajomstiev. Ak dôjde k náhodnému zdieľaniu kľúča, zrušte ho alebo ho otočte v 7stamp Admin a aktualizujte príslušné pripojenie.

Často kladené otázky

Kde získam token 7stamp API?

V 7stamp Admin prejdite na API Integrations → API Keys → Add API Key. Token sa potom odošle v hlavičke Authorization ako Bearer, za ktorým nasleduje kľúč.

Aká je základná URL a metóda autentifikácie?

Použite https://api.7loc.com/cards-api a pošlite Authorization: Bearer YOUR_7STAMP_API_KEY pri každej autorizovanej žiadosti.

Kedy môžem vynechať template_id?

Iba ak má pripojený profil práve jednu aktívnu šablónu karty. Ak je aktívnych viacero šablón, vyberte správnu template_id z GET /templates.

Mám použiť API, Make alebo Zapier?

Použite API pre vlastnú POS, backend, stránku alebo úplnú kontrolu. Pre scenáre vizuálneho vetvenia použite Make. Použite Zapier pre väčšinou lineárny pracovný postup spúšťania. Všetky tri sa spoliehajú na rovnaký kľúč API a zmluvu API.

Ďalší krok

Najprv otestujte najmenší bezpečný tok API

Vytvorte kľúč, zavolajte na číslo GET /templates, vytvorte jednu pozvánku pre kontakt na jedno použitie a potom pridajte produkčné tajomstvá, protokolovanie, opakovanie a spracovanie webhooku okolo overenej požiadavky.