Udviklerintegration

7stamp REST API

Tilgængelig

7stamp Integration API lader en CRM, e-handelsplatform, POS, brugerdefineret backend eller automatiseringsværktøj administrere tegnebogsloyalitetskort med den kontakt-id, dit eget system allerede bruger. Det er den universelle mulighed, når en specialiseret integration ikke eksisterer.

API-basen URL er https://api.7loc.com/cards-api. Autentificer hver anmodning med en API-nøgle som et Bearer-token. Brug den linkede OpenAPI-reference til live-anmodnings- og svarskemaerne, før du bygger produktionslogik.

Hvad du kan gøre med API

API er skrivesiden af ​​integrationsstakken. Brug det, når din egen software skal forblive den operationelle kilde til sandhed, mens 7stamp håndterer tegnebogens loyalitetslag.

Udsted kort fra din egen software

Generer et personligt tegnebogskortlink til enhver kunde i dit system. Lever det via din egen e-mail, SMS, push eller flow i appen. Kunden åbner linket og gemmer kortet på Apple Wallet eller Google Wallet.

Kreditstempler fra enhver kilde

Når et køb lukker i din brugerdefinerede POS, når en onlineordre betales på din hjemmeside, eller når en service er fuldført i dit bookingsystem, skal du ringe til API for at kreditstempler. Kortet opdateres inden for få sekunder.

Administrer værdikuponer og kampagner

Udsted en engangsvoucher til en specifik kunde, opret kampagneklare belønningsflows, og træk værdikuponstatus tilbage i de systemer, der håndterer økonomi og servicekvalitet.

Dokumenteret integration API operationer

Disse er de offentlige API ruter bag Make og Zapier aktionerne. Læs det nøjagtige skema i referencen API; udled ikke feltnavne fra et andet slutpunkt.

Kort POST /cards/invite

Opret en kortinvitation

Opretter en frisk personlig installation URL for en ekstern kontakt.

Kort POST /cards/invite/bulk

Masseopret kortinvitationer

Opretter op til 100 invitationslinks i en kontrolleret batch.

Kort GET /cards

Find kort

Slår kortposter op ved hjælp af ekstern kontakt-id.

Kort GET /cards/{user_card_id}

Få kortdetaljer

Returnerer den fulde tilstand af et kort ved dets interne 7stamp ID.

Kort POST /cards/scan

Scan et kort

Tilføjer stempler med kort ID eller External ID og registrerer kilderækkefølgen, når den leveres.

Skabeloner GET /templates

Liste skabeloner

Viser kortskabeloner tilgængelige for nøglens arbejdsplads/profile.

Skabeloner GET /templates/{template_id}/design

Få skabelondesign

Læser visuelle indstillinger for en kendt kortskabelon.

Kuponer POST /vouchers/issue

Udsted en voucher

Udsteder en voucher til en kortejer.

Beskeder POST /messages/send

Send en besked

Sender tegnebogskort-push og/or e-mail-indhold til en kortejer.

Hvor skal man oprette og kopiere API-tasten

Disse er rigtige 7stamp Admin-skærme. Åbn API & Integrations, tilføj en nøgle, og kopier den derefter til en sikker server-side hemmelighed eller automatiseringsforbindelse.

7stamp Admin API & Integrationsskærm, der viser knappen Add API Key og Generer API Tastedialog
Trin 1 — Vælg ⟦29⟦ integrationer 2, åbn navigationen til venstre API Keys, vælg Add API Key, vælg det relevante personalelogin, og generer nøglen.
7stamp Admin dialog, der viser en nyligt genereret API nøgle og dens kopikontrol
Trin 2 — Kopiér den nye nøgle til en adgangskodeadministrator, serversidehemmelighed eller sikker Make29. Indsæt det ikke i kildekoden, en browserapplikation eller en supportbillet.

Tre beslutninger, der skal træffes før kodning af

API nøgleomfang

Opret nøglen i 7stamp Admin under API Integrations → API KeysAdd API Key. En nøgle hører til én arbejdsplads/profile, så opret separate nøgler til udvikling og produktion, når din kontoopsætning tillader det. Roter eller tilbagekald adgang fra dashboardet, hvis en hemmelighed afsløres.

Kundeidentitet

External ID er den stabile kontakt-id fra dit system: en CRM ID, kunde UUID, telefonnummer, e-mail. Foretrækker et uforanderligt system ID. Tilføj eventuelt External Source for at undgå kollisioner på tværs af systemer og for at gøre webhook-korrelation eksplicit.

Skabelonvalg

Når profilen har én aktiv skabelon, kan template_id udelades, og 7stamp vælger den automatisk. Når den har flere aktive skabeloner, skal du videregive den tilsigtede template_id. Læs GET /templates først i stedet for at hardkode en gættet ID.

Minimal godkendt anmodning: opret en invitation

Kopier dette til dit automatiseringstrin 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
  }'

Fra API nøgle til en første vellykket anmodning

01

Log ind på 7stamp Admin og opret en nøgle: ⟦229. Gem det i din hemmelige manager, ikke i kildekoden eller et program på klientsiden.

02

Indstil basen URL til https://api.7loc.com/cards-api og tilføj Authorization: Bearer efterfulgt af nøglen til hver server-side anmodning.

03

Ring først til GET /templates. Et vellykket svar bekræfter tokenet og viser de skabeloner, der er tilgængelige for den pågældende arbejdsplads/profile.

04

Vælg den stabile External ID og valgfri External Source fra dit eget system. Brug nøjagtig samme identitetspar i oprettelse, scanning, opslag og webhook-logik.

05

Ring til POST /cards/invite med en engangstestkontakt. Bekræft den returnerede installation URL, før du automatiserer levering til rigtige kunder.

06

Tilføj kun POST /cards/scan, voucher eller beskedhandlinger, når du har logget, fejlhåndtering og en sikker genforsøgsstrategi /idempotency i din egen backend.

Brug referencen API som kontrakt

Den offentlige Swagger/OpenAPI-reference indeholder det aktuelle slutpunkt, parameter, anmodningstekst, svar og webhook-skemaer. Den interaktive URL er https://api.7loc.com/cards-api/docs og den maskinlæsbare kontrakt er https://api.7loc.com/cards-api/openapi.json. Læs den, før du implementerer fejlhåndtering eller tilføjer valgfrie felter.

Autentificering og nøglesikkerhed

Nøglen er en hemmelighed på serversiden. Udsæt det ikke i browserens JavaScript, en mobil app-pakke, en offentlig formular, skærmbilleder, Make/Zapier tekstfelter eller supportbilletter. Brug en server, sikker automatiseringsforbindelse eller hemmelig administrator. Hvis nøglen nogensinde bliver delt ved et uheld, skal du tilbagekalde eller rotere den i 7stamp Admin og opdatere den berørte forbindelse.

Ofte stillede spørgsmål

Hvor får jeg et 7stamp API-token?

I 7stamp Admin skal du gå til API Integrations → API Keys → Add API Key. Tokenet sendes derefter i Authorization-headeren som Bearer efterfulgt af nøglen.

Hvad er basis URL og godkendelsesmetode?

Brug https://api.7loc.com/cards-api og send Authorization: Bearer YOUR_7STAMP_API_KEY på hver autoriseret anmodning.

Hvornår må jeg udelade template_id?

Kun når den tilsluttede profil har præcis én aktiv kortskabelon. Hvis flere skabeloner er aktive, skal du vælge den korrekte template_id fra GET /templates.

Skal jeg bruge API, Make eller Zapier?

Brug API til en brugerdefineret POS, backend, websted eller fuld kontrol. Brug Make til visuelle forgreningsscenarier. Brug Zapier til en for det meste lineær trigger-action workflow. Alle tre er afhængige af den samme API-nøgle og API-kontrakt.

Næste skridt

Test det mindste sikre API flow først

Opret nøglen, ring til GET /templates, opret én invitation til en engangskontakt, tilføj derefter produktionshemmeligheder, logning, genforsøg og webhook-håndtering omkring den dokumenterede anmodning.