Integracija razvijalca

7stamp REST API

Na voljo

7stamp Integration API omogoča CRM, platformo za e-trgovino, POS, zaledje po meri ali orodje za avtomatizacijo upravljajte kartice zvestobe denarnice z identifikatorjem stika, ki ga vaš sistem že uporablja. To je univerzalna možnost, ko specializirana integracija ne obstaja.

API osnova URL je https://api.7loc.com/cards-api. Preverjanje pristnosti vsake zahteve s ključem API kot žeton Bearer. Uporabite povezano referenco OpenAPI za sheme zahtev in odgovorov v živo, preden zgradite proizvodno logiko.

Kaj lahko storite z API

API je pisalna stran integracijskega sklada. Uporabite ga, kadar naj vaša lastna programska oprema ostane operativni vir resnice, medtem ko 7stamp skrbi za plast zvestobe denarnice.

Izdajte kartice iz lastne programske opreme

Ustvarite povezavo kartice osebne denarnice za katero koli stranko v vašem sistemu. Dostavite ga prek lastne e-pošte, SMS, potiskanja ali toka v aplikaciji. Stranka odpre povezavo in kartico shrani na Apple Wallet ali Google Wallet.

Kreditne znamke iz katerega koli vira

Ko se nakup zaključi v vašem prilagojenem POS, ko je spletno naročilo plačano na vašem spletnem mestu ali ko je storitev opravljena v vašem rezervacijskem sistemu, pokličite API za dobroimetje. Kartica se posodobi v nekaj sekundah.

Upravljajte vavčerje in akcije

Izdajte enkratni vavčer določeni stranki, ustvarite tokove nagrad, pripravljene za kampanjo, in potegnite status vavčerja nazaj v sisteme, ki obravnavajo finance in kakovost storitev.

Dokumentirana integracija API operacije

To so javne API poti za dejanja Make in Zapier. Preberite natančno shemo v sklicu API; ne sklepajte imen polj iz druge končne točke.

Kartice POST /cards/invite

Ustvari povabilo s kartico

Ustvari novo osebno namestitev URL za zunanji stik.

Kartice POST /cards/invite/bulk

Množično ustvarjanje povabil za kartice

Ustvari do 100 povezav za povabila v nadzorovani seriji.

Kartice GET /cards

Iskanje kartic

Poišče zapise kartic po zunanjem identifikatorju kontakta.

Kartice GET /cards/{user_card_id}

Pridobi podrobnosti kartice

Vrne celotno stanje ene kartice z njenim notranjim 7stamp ID.

Kartice POST /cards/scan

Skeniraj kartico

Doda žige po kartici ID ali External ID in zabeleži izvorni vrstni red, ko je na voljo.

Predloge GET /templates

Seznam predlog

Seznam predlog kartic, ki so na voljo za delovno mesto ključa/profile.

Predloge GET /templates/{template_id}/design

Pridobite oblikovanje predloge

Bere vizualne nastavitve za znano predlogo kartice.

Boni POST /vouchers/issue

Izdaja kupona

Izda bon lastniku kartice.

Sporočila POST /messages/send

Pošlji sporočilo

Pošlje vsebino kartice denarnice in /or lastniku kartice.

Kam ustvariti in kopirati ključ API

To so pravi zasloni 7stamp Admin. Odprite API & Integrations, dodajte ključ in ga nato kopirajte v varno skrivno ali avtomatizirano povezavo na strani strežnika.

7stamp Admin API & Integrations zaslon, ki prikazuje gumb Add API Key in pogovorno okno Generate API Key
1. korak — Izberite API & Integrations v levem podoknu za krmarjenje, odprite API Keys, izberite Add API Key, izberite ustrezno prijavo osebja in ustvarite ključ. Pogovorno okno
7stamp Admin, ki prikazuje na novo ustvarjen ključ API in njegov nadzor kopiranja
2. korak — Kopirajte nov ključ v upravitelja gesel, skrivnost na strani strežnika ali varno povezavo Make/Zapier. Ne prilepite ga v izvorno kodo, aplikacijo brskalnika ali prijavo za podporo.

Tri odločitve, ki jih morate sprejeti pred kodiranjem

API obseg ključa

Ustvarite ključ v 7stamp Admin pod API Integrations → API KeysAdd API Key. Ključ pripada enemu delovnemu mestu/profile, zato ustvarite ločene ključe za razvoj in proizvodnjo, ko to omogoča nastavitev vašega računa. Obrnite ali prekličite dostop z nadzorne plošče, če je skrivnost razkrita.

Identiteta stranke

External ID je stabilen identifikator stika iz vašega sistema: CRM ID, stranka UUID, telefonska številka ali e-pošta. Raje nespremenljiv sistem ID. Po želji dodajte External Source, da se izognete kolizijam med sistemi in da bo korelacija webhook eksplicitna.

Izbira predloge

Ko ima profil eno aktivno predlogo, lahko template_id izpustite in 7stamp jo izbere samodejno. Ko ima več aktivnih predlog, posredujte predvideno template_id. Najprej preberite GET /templates, namesto da bi trdo kodirali ugibano ID.

Minimalna overjena zahteva: ustvarite povabilo

Kopirajte to v svoj korak avtomatizacije 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 ključa API do prve uspešne zahteve

01

Prijavite se v 7stamp Admin in ustvarite ključ: API Integrations → API KeysAdd API Key. Shranite ga v svoj skrivni upravitelj, ne v izvorno kodo ali aplikacijo na strani odjemalca.

02

Nastavite osnovo URL na https://api.7loc.com/cards-api in dodajte Authorization: Bearer, ki mu sledi ključ za vsako zahtevo na strani strežnika.

03

Najprej pokličite GET /templates. Uspešen odgovor potrdi žeton in prikaže predloge, ki so na voljo za to delovno mesto/profile.

04

Izberite stabilno External ID in izbirno External Source iz svojega sistema. Uporabite popolnoma enak par identitet v logiki ustvarjanja, skeniranja, iskanja in webhooka.

05

Pokličite POST /cards/invite s testnim kontaktom za enkratno uporabo. Preverite vrnjeno namestitev URL, preden avtomatizirate dostavo pravim strankam.

06

Dodajte POST /cards/scan, vavčer ali sporočilna dejanja šele, ko imate v lastnem ozadju strategijo beleženja, obravnavanja napak in varnega ponovnega poskusa/idempotency.

Uporabi sklic API kot pogodbo

Javna referenca Swagger/OpenAPI vsebuje trenutno končno točko, parameter, telo zahteve, odgovor in sheme webhook. Interaktivna URL je https://api.7loc.com/cards-api/docs in strojno berljiva pogodba je https://api.7loc.com/cards-api/openapi.json. Preberite jo, preden uvedete obravnavanje napak ali dodate izbirna polja.

Preverjanje pristnosti in varnost ključev

Ključ je skrivnost na strani strežnika. Ne izpostavljajte ga v JavaScriptu brskalnika, paketu mobilnih aplikacij, javnem obrazcu, posnetkih zaslona, ​​besedilnih poljih Make/Zapier ali prijavah za podporo. Uporabite strežnik, varno povezavo za avtomatizacijo ali tajnega upravitelja. Če je ključ slučajno deljen, ga prekličite ali obrnite v 7stamp Admin in posodobite prizadeto povezavo.

Pogosto zastavljena vprašanja

Kje dobim žeton 7stamp API?

V 7stamp Admin pojdite na API Integrations → API Keys → Add API Key. Žeton se nato pošlje v glavi Authorization kot Bearer, ki mu sledi ključ.

Kaj je osnova URL in metoda preverjanja pristnosti?

Uporabite https://api.7loc.com/cards-api in pošljite Authorization: Bearer YOUR_7STAMP_API_KEY za vsako avtorizirano zahtevo.

Kdaj lahko izpustim template_id?

Samo, če ima povezani profil točno eno aktivno predlogo kartice. Če je aktivnih več predlog, izberite pravilno template_id izmed GET /templates.

Ali naj uporabim API, Make ali Zapier?

Uporabite API za POS po meri, zaledje, spletno mesto ali popoln nadzor. Uporabite Make za scenarije vizualnega razvejanja. Uporabite Zapier za večinoma linearni potek dela sprožilnega dejanja. Vsi trije se zanašajo na isti ključ API in pogodbo API.

Naslednji korak

Najprej preizkusite najmanjši varni pretok API

Ustvarite ključ, pokličite GET /templates, ustvarite eno povabilo za stik za enkratno uporabo, nato dodajte proizvodne skrivnosti, beleženje, ponovne poskuse in ravnanje s spletnim kljukom okoli preverjene zahteve.