Kūrėjų integracija

7stamp REST API

Yra

7stamp Integration API leidžia CRM, el. prekybos platformai, POS, tinkintai vidinei sistemai arba automatizavimo įrankiui tvarkyti piniginės lojalumo korteles su kontakto identifikatoriumi, kurį jau naudoja jūsų sistema. Tai universalus pasirinkimas, kai nėra specializuotos integracijos.

API bazė URL yra https://api.7loc.com/cards-api. Autentifikuokite kiekvieną užklausą naudodami raktą API kaip prieigos raktą Bearer. Prieš kurdami gamybos logiką naudokite susietą nuorodą OpenAPI tiesioginėms užklausų ir atsakymų schemoms.

Ką galite padaryti su API

API yra integravimo krūvos rašymo pusė. Naudokite jį visada, kai jūsų programinė įranga turėtų likti veikiančiu tiesos šaltiniu, o 7stamp tvarko piniginės lojalumo sluoksnį.

Išduokite korteles iš savo programinės įrangos

Sukurkite asmeninės piniginės kortelės nuorodą bet kuriam jūsų sistemos klientui. Pateikite jį savo el. paštu SMS, iš karto arba srautu programoje. Klientas atidaro nuorodą ir išsaugo kortelę numeriu Apple Wallet arba Google Wallet.

Kredito antspaudai iš bet kurio šaltinio

Kai baigiamas pirkimas pagal jūsų pasirinktą POS, kai jūsų svetainėje apmokamas internetinis užsakymas arba kai paslauga atliekama jūsų užsakymo sistemoje, skambinkite numeriu API, kad gautumėte kredito ženklų. Kortelė atnaujinama per kelias sekundes.

Tvarkykite kuponus ir kampanijas

Išduokite vienkartinį kuponą konkrečiam klientui, sukurkite kampanijai paruoštus atlygio srautus ir grąžinkite kupono būseną į sistemas, kurios tvarko finansus ir paslaugų kokybę.

Dokumentuotos integravimo API operacijos

Tai yra vieši maršrutai API už veiksmų Make ir Zapier. Tikslią schemą skaitykite nuorodoje API; nenurodykite laukų pavadinimų iš kito galutinio taško.

Kortelės POST /cards/invite

Sukurkite kortelės kvietimą

Sukuria naują asmeninį išorinio kontakto diegimą URL.

Kortelės POST /cards/invite/bulk

Masinis kortelių kvietimų kūrimas

Sukuria iki 100 kvietimų nuorodų kontroliuojamoje grupėje.

Kortelės GET /cards

Raskite korteles

Ieško kortelės įrašų pagal išorinį kontakto identifikatorių.

Kortelės GET /cards/{user_card_id}

Gaukite išsamią kortelės informaciją

Grąžina visą vienos kortelės būseną pagal jos vidinę 7stamp ID.

Kortelės POST /cards/scan

Nuskaitykite kortelę

Prideda antspaudus kortele ID arba External ID ir įrašo šaltinio užsakymą, kai pateikiama.

Šablonai GET /templates

Sąrašo šablonai

Išvardija kortelių šablonus, pasiekiamus rakto darbo vietoje/profile.

Šablonai GET /templates/{template_id}/design

Gaukite šablono dizainą

Nuskaito žinomo kortelės šablono vaizdinius nustatymus.

Kuponai POST /vouchers/issue

Išduokite kuponą

Išduoda kuponą kortelės savininkui.

Žinutės POST /messages/send

Siųsti žinutę

Siunčia piniginės kortelės siuntimo ir/or el. pašto turinį kortelės savininkui.

Kur sukurti ir nukopijuoti klavišą API

Tai tikri 7stamp Admin ekranai. Atidarykite API & Integracijos, pridėkite raktą, tada nukopijuokite jį į saugų serverio slaptąjį arba automatinį ryšį.

7stamp Admin API & Integracijos ekranas, kuriame rodomas mygtukas Add API Key ir Generuoti API klavišų dialogo langas
1 veiksmas – kairėje pusėje atidarykite integravimą ir 7 – 25. API Keys, pasirinkite Add API Key, pasirinkite atitinkamą personalo prisijungimo vardą ir sugeneruokite raktą.
7stamp Admin dialogo langas, kuriame rodomas naujai sugeneruotas API raktas ir jo kopijavimo valdymas
2 veiksmas – nukopijuokite naują raktą į slaptažodžių tvarkyklę, serverio slaptą arba saugų ryšį Make7/92. Neįklijuokite jo į šaltinio kodą, naršyklės programą ar palaikymo bilietą.

Trys sprendimai, kuriuos reikia priimti prieš koduojant

API rakto apimtis

Sukurkite raktą laukelyje 7stamp Admin, esantį API Integrations → API KeysAdd API Key. Raktas priklauso vienai darbo vietai/profile, todėl kurkite atskirus kūrimo ir gamybos raktus, kai tai leidžia paskyros sąranka. Pasukite arba atšaukite prieigą prie prietaisų skydelio, jei atskleista paslaptis.

Kliento tapatybė

External ID yra stabilus kontakto identifikatorius iš jūsų sistemos: CRM ID, klientas ⟦25715, el. pašto adresas, telefono numeris. Pirmenybę teikite nekintamai sistemai ID. Pasirinktinai pridėkite External Source, kad išvengtumėte sistemų susidūrimų ir kad „Webhook“ koreliacija būtų aiški.

Šablonų pasirinkimas

Kai profilyje yra vienas aktyvus šablonas, template_id galima praleisti ir 7stamp pasirenka jį automatiškai. Kai yra keli aktyvūs šablonai, perduokite numatytą template_id. Pirmiausia perskaitykite GET /templates, o ne sunkiai užkoduokite spėjamą ID.

Minimali autentifikuota užklausa: sukurkite kvietimą

Nukopijuokite tai į automatizavimo veiksmą 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
  }'

Nuo API rakto iki pirmosios sėkmingos užklausos

01

Prisijunkite prie 7stamp Admin ir sukurkite raktą: API Integrations → API KeysAdd API Key. Saugokite jį slaptoje tvarkyklėje, o ne šaltinio kode ar kliento programoje.

02

Nustatykite bazę URL į https://api.7loc.com/cards-api ir pridėkite Authorization: Bearer, o po to raktą prie kiekvienos serverio pusės užklausos.

03

Pirmiausia skambinkite GET /templates. Sėkmingas atsakymas patvirtina prieigos raktą ir parodo toje darbo vietoje pasiekiamus šablonus/profile.

04

Pasirinkite stabilųjį External ID ir pasirenkamą External Source iš savo sistemos. Naudokite tą pačią tapatybės porą kurdami, nuskaitydami, ieškodami ir „Webhook“ logikos.

05

Skambinkite POST /cards/invite naudodami vienkartinį bandomąjį kontaktą. Prieš automatizuodami pristatymą tikriems klientams, patikrinkite grąžintą diegimą URL.

06

Pridėkite POST /cards/scan, kuponą arba pranešimo veiksmus tik tada, kai turėsite registravimo, klaidų tvarkymo ir saugaus pakartotinio bandymo/idempotency strategiją savo foninėje sistemoje.

Naudokite nuorodą API kaip sutartį

Viešoje nuorodoje Swagger/OpenAPI yra dabartinis galutinis taškas, parametras, užklausos turinys, atsakymas ir žiniatinklio kablio schemos. Interaktyvus URL yra https://api.7loc.com/cards-api/docs, o mašininiu būdu nuskaitoma sutartis yra https://api.7loc.com/cards-api/openapi.json. Perskaitykite ją prieš įdiegdami klaidų tvarkymą arba pridėdami pasirenkamus laukus.

Autentifikavimas ir raktų sauga

Raktas yra serverio pusės paslaptis. Nenurodykite jo naršyklės „JavaScript“, mobiliųjų programų rinkinyje, viešoje formoje, ekrano kopijose, Make/Zapier teksto laukuose ar palaikymo bilietuose. Naudokite serverį, saugų automatizavimo ryšį arba slaptą tvarkyklę. Jei raktas kada nors netyčia bendrinamas, atšaukite arba pasukite jį 7stamp Admin ir atnaujinkite paveiktą ryšį.

Dažnai užduodami klausimai

Kur gauti 7stamp API žetoną?

Skiltyje 7stamp Admin eikite į API Integrations → API Keys → Add API Key. Tada prieigos raktas siunčiamas antraštėje Authorization kaip Bearer, po kurio nurodomas raktas.

Kas yra bazinis URL ir autentifikavimo metodas?

Naudokite https://api.7loc.com/cards-api ir siųskite Authorization: Bearer YOUR_7STAMP_API_KEY kiekvienoje įgaliotoje užklausoje.

Kada galiu praleisti template_id?

Tik tada, kai prijungtame profilyje yra tiksliai vienas aktyvus kortelės šablonas. Jei aktyvūs keli šablonai, pasirinkite tinkamą template_id iš GET /templates.

Ar turėčiau naudoti API, Make arba Zapier?

Naudokite API tinkintam POS, pagrindinei programai, svetainei arba visam valdymui. Naudokite Make vizualaus išsišakojimo scenarijams. Naudokite Zapier dažniausiai tiesinei trigerio veiksmų eigai. Visi trys remiasi tuo pačiu API raktu ir API sutartimi.

Kitas žingsnis

Pirmiausia patikrinkite mažiausią saugų API srautą

Sukurkite raktą, paskambinkite GET /templates, sukurkite vieną pakvietimą vienkartiniam kontaktui, tada pridėkite gamybos paslaptis, registravimą, pakartotinius bandymus ir žiniatinklio kablio tvarkymą pagal patvirtintą užklausą.