Fejlesztői integráció

7stamp REST API

Elérhető

A 7stamp Integration API lehetővé teszi, hogy egy CRM, e-kereskedelmi platform, POS, egyéni háttérrendszer vagy automatizálási eszköz kezelje a pénztárca hűségkártyákat a saját rendszere által már használt kapcsolati azonosítóval. Ez az univerzális lehetőség, ha nem létezik speciális integráció.

Az API alap URL a https://api.7loc.com/cards-api. Hitelesítsen minden kérést egy API kulccsal Bearer tokenként. Használja a hivatkozott OpenAPI hivatkozást az élő kérés- és válaszsémákhoz, mielőtt létrehozná a termelési logikát.

Mit tehet a API

Az API az integrációs verem írási oldala. Használja, amikor a saját szoftvere az igazság működési forrása marad, miközben a 7stamp kezeli a pénztárca hűségrétegét.

Saját szoftverből állíthat ki kártyákat

Személyes pénztárcakártya hivatkozás létrehozása a rendszerében lévő bármely ügyfél számára. Küldje el saját e-mail-címén, SMS-on, push-on vagy alkalmazáson belüli folyamaton keresztül. Az ügyfél megnyitja a linket, és elmenti a kártyát a Apple Wallet vagy a Google Wallet számra.

Hitelbélyegek bármilyen forrásból

Amikor a vásárlás lezárul az Ön egyéni POS számában, ha online rendelést fizetnek ki a webhelyén, vagy amikor egy szolgáltatás befejeződik a foglalási rendszerében, hívja a API számot a jóváírásért. A kártya másodperceken belül frissül.

Utalványok és kampányok kezelése

Egyszeri utalvány kiállítása egy adott ügyfél számára, kampánykész jutalomfolyamatok létrehozása, valamint az utalvány státuszának visszaállítása a pénzügyi és szolgáltatási minőséget kezelő rendszerekbe.

Dokumentált integrációs API műveletek

Ezek a nyilvános API útvonalak a Make és Zapier műveletek mögött. Olvassa el a pontos sémát a API hivatkozásban; ne következtessen mezőnevekre egy másik végpontból.

Kártyák POST /cards/invite

Hozzon létre egy meghívót

Új személyes telepítést hoz létre URL egy külső kapcsolathoz.

Kártyák POST /cards/invite/bulk

Kártyameghívók tömeges létrehozása

Akár 100 meghívó hivatkozást hoz létre egy ellenőrzött kötegben.

Kártyák GET /cards

Keressen kártyákat

Megkeresi a kártyarekordokat külső kapcsolati azonosító alapján.

Kártyák GET /cards/{user_card_id}

Szerezze meg a kártya adatait

Egy kártya teljes állapotát adja vissza a belső 7stamp ID szerint.

Kártyák POST /cards/scan

Olvass be egy kártyát

Bélyegzőket ad hozzá a ID vagy External ID kártyával, és rögzíti a forrásrendelést, ha rendelkezésre áll.

Sablonok GET /templates

Lista sablonok

Felsorolja a kulcs munkahelyén elérhető kártyasablonokat/profile.

Sablonok GET /templates/{template_id}/design

Szerezzen sablontervet

Beolvassa egy ismert kártyasablon vizuális beállításait.

Utalványok POST /vouchers/issue

Állítson ki egy utalványt

Utalványt állít ki a kártyatulajdonosnak.

Üzenetek POST /messages/send

Üzenet küldése

Wallet-card push és /or e-mail tartalmat küld a kártyatulajdonosnak.

A API kulcs létrehozása és másolása

Ezek valódi 7stamp Admin képernyők. Nyissa meg a API & Integrations alkalmazást, adjon hozzá egy kulcsot, majd másolja azt egy biztonságos szerveroldali titkos vagy automatizálási kapcsolatba.

7stamp Admin API & Integrációk képernyő, amelyen látható a Add API Key gomb és a Generálás API Billentyűpárbeszéd
1. lépés: Nyissa meg a navigációt és a 229 lehetőséget a bal oldalon⦁16. API Keys, válassza a Add API Key lehetőséget, válassza ki a megfelelő személyzeti bejelentkezést, és hozza létre a kulcsot.
7stamp Admin párbeszédpanel, amely egy újonnan generált API kulcsot és annak másolási vezérlőjét mutatja
2. lépés – Másolja át az új kulcsot egy jelszókezelőbe, egy szerveroldali titkos adatba vagy egy biztonságos Make16/2323⟦16233. Ne illessze be forráskódba, böngészőalkalmazásba vagy támogatási jegybe.

Három döntés a kódolás előtt:

API kulcs hatóköre

Hozza létre a kulcsot a 7stamp Admin alatt a API Integrations → API KeysAdd API Key alatt. Egy kulcs egy munkahelyhez tartozik/profile, ezért hozzon létre külön kulcsokat a fejlesztéshez és az előállításhoz, amikor a fiókbeállítások lehetővé teszik. Forgassa el vagy vonja vissza a hozzáférést az irányítópulton, ha egy titok kiderül.

Ügyfélazonosító

External ID a rendszer stabil kapcsolati azonosítója: CRM ID, ügyfél ⟦16155 vagy e-mail, telefonszám. Inkább változtathatatlan rendszert ID. Opcionálisan adja hozzá a External Source-t a rendszerek közötti ütközések elkerülése és a webhook-korreláció egyértelművé tétele érdekében.

Sablon kiválasztása

Ha a profilnak egy aktív sablonja van, a template_id elhagyható, és a 7stamp automatikusan kiválasztja. Ha több aktív sablonja van, adja át a kívánt template_id-t. Először olvassa el a GET /templates-t, nehogy keményen kódoljon egy kitalált ID-t.

Minimális hitelesített kérelem: hozzon létre egy meghívót

Másolja ezt az automatizálási lépésbe 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
  }'

A API kulcstól az első sikeres kérésig

01

Jelentkezzen be a 7stamp Admin címre, és hozzon létre egy kulcsot: API Integrations → API KeysAdd API Key. Tárolja a titkos kezelőjében, ne a forráskódban vagy egy ügyféloldali alkalmazásban.

02

Állítsa az URL alapértéket https://api.7loc.com/cards-api-ra, és adja hozzá a Authorization: Bearer, majd a kulcsot minden szerveroldali kéréshez.

03

Először hívja a GET /templates számot. A sikeres válasz megerősíti a tokent, és megjeleníti az adott munkahelyen elérhető sablonokat/profile.

04

Válassza ki a stabil External ID és az opcionális External Source számot a saját rendszeréből. Pontosan ugyanazt az identitáspárt használja a létrehozási, vizsgálati, keresési és webhook logikában.

05

Hívja a POST /cards/invite számot egy eldobható tesztérintkezővel. Ellenőrizze a visszaküldött URL telepítést, mielőtt automatizálná a valódi ügyfelekhez való eljuttatást.

06

A POST /cards/scan, utalvány vagy üzenetműveletek hozzáadása csak azután lehetséges, ha a saját háttérrendszerében már rendelkezik naplózási, hibakezelési és biztonságos újrapróbálkozási /idempotency stratégiával.

Használja a API hivatkozást szerződésként

A nyilvános Swagger/OpenAPI hivatkozás tartalmazza az aktuális végpont-, paraméter-, kéréstörzs-, válasz- és webhook-sémákat. Az interaktív URL a https://api.7loc.com/cards-api/docs, a géppel olvasható szerződés pedig a https://api.7loc.com/cards-api/openapi.json. Olvassa el a hibakezelés végrehajtása vagy az opcionális mezők hozzáadása előtt.

Hitelesítés és kulcsbiztonság

A kulcs szerveroldali titkos. Ne tegye közzé a böngésző JavaScriptjében, mobilalkalmazás-csomagban, nyilvános űrlapon, képernyőképekben, Make/Zapier szövegmezőkben vagy támogatási jegyekben. Használjon szervert, biztonságos automatizálási kapcsolatot vagy titkos kezelőt. Ha a kulcsot véletlenül megosztják, vonja vissza vagy forgassa el a 7stamp Admin helyen, és frissítse az érintett kapcsolatot.

Gyakran ismételt kérdések

Hol kaphatok 7stamp API tokent?

A 7stamp Admin mezőben lépjen a API Integrations → API Keys → Add API Key címre. A tokent ezután a Authorization fejlécben Bearer néven küldi el, majd a kulcsot.

Mi az alap URL és hitelesítési módszer?

Használja a https://api.7loc.com/cards-api kódot, és küldje el a Authorization: Bearer YOUR_7STAMP_API_KEY kódot minden engedélyezett kérésnél.

Mikor hagyhatom ki a template_id számot?

Csak akkor, ha a csatlakoztatott profilnak pontosan egy aktív kártyasablonja van. Ha több sablon is aktív, válassza ki a megfelelő template_id GET /templates.

közül. Használjam a API, Make vagy ⟦118?

Használja a API kódot egyéni POS, háttérrendszerhez, webhelyhez vagy teljes vezérléshez. Használja a Make-t a vizuális elágazási forgatókönyvekhez. Használja a Zapier-t egy többnyire lineáris trigger-művelet munkafolyamathoz. Mindhárom ugyanazon API kulcson és API szerződésen alapul.

Következő lépés

Tesztelje a legkisebb biztonságos API áramlást először

Hozza létre a kulcsot, hívja a GET /templates számot, hozzon létre egy meghívót egy eldobható kapcsolattartó számára, majd adja hozzá a gyártási titkokat, a naplózást, az újrapróbálkozásokat és a webhook kezelést a bevált kérés köré.