Integrarea dezvoltatorului

7stamp REST API

Disponibil

7stamp Integration API permite unui CRM, platformă de comerț electronic, POS, backend personalizat sau instrument de automatizare să gestioneze cardurile de fidelitate portofel cu identificatorul de contact pe care sistemul dvs. îl folosește deja. Este varianta universală atunci când nu există o integrare specializată.

Baza API URL este https://api.7loc.com/cards-api. Autentificați fiecare solicitare cu o cheie API ca simbol Bearer. Utilizați referința legată OpenAPI pentru cererile live și schemele de răspuns înainte de a construi logica de producție.

Ce poți face cu API

API este partea de scriere a stivei de integrare. Folosește-l ori de câte ori propriul tău software ar trebui să rămână sursa operațională a adevărului, în timp ce 7stamp se ocupă de nivelul de loialitate al portofelului.

Emite carduri din propriul tău software

Generați un link pentru cardul de portofel personal pentru orice client din sistemul dvs. Trimiteți-l prin e-mail propriu, SMS, push sau flux în aplicație. Clientul deschide linkul și salvează cardul în Apple Wallet sau Google Wallet.

Timbre de credit din orice sursă

Când se închide o achiziție în POS personalizat, când o comandă online este plătită pe site-ul dvs. sau când un serviciu este finalizat în sistemul dvs. de rezervare, sunați la API pentru timbre de credit. Cardul se actualizează în câteva secunde.

Gestionați vouchere și campanii

Emiteți un voucher unic unui anumit client, creați fluxuri de recompense pregătite pentru campanie și retrageți starea voucherului în sistemele care gestionează finanțarea și calitatea serviciilor.

Operațiuni de integrare documentate API

Acestea sunt rutele publice API din spatele acțiunilor Make și Zapier. Citiți schema exactă în referința API; nu deduceți numele câmpurilor de la un punct final diferit.

Carduri POST /cards/invite

Creați o invitație pe card

Creează o nouă instalare personală URL pentru un contact extern.

Carduri POST /cards/invite/bulk

Creați în bloc invitații pe card

Creează până la 100 de link-uri de invitație într-un lot controlat.

Carduri GET /cards

Găsiți cărți

Caută înregistrările cardului după identificatorul de contact extern.

Carduri GET /cards/{user_card_id}

Obțineți detaliile cardului

Returnează starea completă a unui card prin 7stamp ID intern.

Carduri POST /cards/scan

Scanați un card

Adaugă ștampile prin card ID sau External ID și înregistrează comanda sursă atunci când este furnizată.

Șabloane GET /templates

Listează șabloane

Listează șabloanele de carduri disponibile la locul de muncă al cheii/profile.

Șabloane GET /templates/{template_id}/design

Obțineți un design șablon

Citește setările vizuale pentru un șablon de card cunoscut.

Vouchere POST /vouchers/issue

Emite un voucher

Emite un voucher unui proprietar de card.

Mesaje POST /messages/send

Trimite un mesaj

Trimite conținut push-carte de portofel și/or e-mail către proprietarul cardului.

Unde să creați și să copiați cheia API

Acestea sunt ecrane reale 7stamp Admin. Deschideți API și integrări, adăugați o cheie, apoi copiați-o într-o conexiune de automatizare sau secretă pe server.

7stamp Admin API & Ecran de integrări care afișează butonul Add API Key și Generare API Dialog cheie
Step 1 — Select API & Integrations in the left navigation, open API Keys, choose Add API Key, select the appropriate staff login, and generate the key.
7stamp Admin casetă de dialog care arată o cheie API nou generată și controlul copierii acesteia
Pasul 2 — Copiați noua cheie într-un manager de parole, secret pe server sau conexiune securizată Make1⟧191/⟧. Nu-l inserați în codul sursă, într-o aplicație de browser sau într-un bilet de asistență.

Trei decizii de luat înainte de codare

API domeniul de aplicare al cheii

Creați cheia în 7stamp Admin sub API Integrations → API KeysAdd API Key. O cheie aparține unui singur loc de muncă/profile, așa că creați chei separate pentru dezvoltare și producție atunci când configurarea contului o permite. Rotiți sau revocați accesul din tabloul de bord dacă este expus un secret.

Identitatea clientului

External ID este identificatorul stabil de contact din sistemul dvs.: a CRM ID, client UUID, sau e-mail, număr de telefon. Prefer un sistem imuabil ID. Adăugați opțional External Source pentru a evita coliziunile între sisteme și pentru a face explicită corelația webhook.

Selectarea șablonului

Când profilul are un șablon activ, template_id poate fi omis și 7stamp îl selectează automat. Când are mai multe șabloane active, treceți template_id. Citiți mai întâi GET /templates în loc să codificați tare un ID ghicit.

Solicitare minimă autentificată: creați o invitație

Copiați acest lucru în pasul dvs. de automatizare 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
  }'

De la cheia API la o primă solicitare reușită

01

Conectați-vă la 7stamp Admin și creați o cheie: API Integrations → API KeysAdd API Key191. Stocați-l în managerul dvs. secret, nu în codul sursă sau într-o aplicație pe partea clientului.

02

Setați baza URL la https://api.7loc.com/cards-api și adăugați Authorization: Bearer urmat de cheia fiecărei cereri de pe partea serverului.

03

Sună mai întâi la GET /templates. Un răspuns de succes confirmă simbolul și arată șabloanele disponibile pentru acel loc de muncă/profile.

04

Alegeți stabilul External ID și opțional External Source din propriul sistem. Utilizați exact aceeași pereche de identitate în logica de creare, scanare, căutare și webhook.

05

Sunați la POST /cards/invite cu un contact de testare de unică folosință. Verificați instalarea returnată URL înainte de a automatiza livrarea către clienți reali.

06

Adăugați POST /cards/scan, voucher sau acțiuni de mesaje numai după ce aveți o strategie de logare, de gestionare a erorilor și o reîncercare sigură/idempotency în propriul backend.

Utilizați referința API ca contract

Referința publică Swagger/OpenAPI conține punctul final curent, parametrul, corpul cererii, răspunsul și schemele webhook. URL interactiv este https://api.7loc.com/cards-api/docs și contractul care poate fi citit de mașină este https://api.7loc.com/cards-api/openapi.json. Citiți-l înainte de a implementa gestionarea erorilor sau de a adăuga câmpuri opționale.

Autentificarea și siguranța cheii

Cheia este un secret pe partea serverului. Nu-l expuneți în JavaScript de browser, într-un pachet de aplicații mobile, într-un formular public, în capturi de ecran, în câmpurile de text Make/Zapier sau în bilete de asistență. Utilizați un server, o conexiune de automatizare securizată sau un manager secret. Dacă cheia este partajată accidental, revocați-o sau rotiți-o în 7stamp Admin și actualizați conexiunea afectată.

Întrebări frecvente

De unde iau un token 7stamp API?

În 7stamp Admin, accesați API Integrations → API Keys → Add API Key. Jetonul este apoi trimis în antetul Authorization ca Bearer urmat de cheie.

Care este baza URL și metoda de autentificare?

Folosiți https://api.7loc.com/cards-api și trimiteți Authorization: Bearer YOUR_7STAMP_API_KEY la fiecare cerere autorizată.

Când pot omite template_id?

Numai când profilul conectat are exact un șablon de card activ. Dacă sunt active mai multe șabloane, selectați template_id corect din GET /templates.

Ar trebui să folosesc API, Make sau Make?

Utilizați API pentru un POS, backend, site sau control deplin personalizat. Utilizați Make pentru scenarii de ramificare vizuală. Utilizați Zapier pentru un flux de lucru cu acțiune de declanșare în mare parte liniară. Toți trei se bazează pe aceeași cheie API și pe același contract API.

Următorul pas

Testați mai întâi cel mai mic seif API flux

Creați cheia, sunați la GET /templates, creați o invitație pentru un contact de unică folosință, apoi adăugați secrete de producție, înregistrare, reîncercări și gestionarea webhook în jurul cererii dovedite.