Kehittäjäintegraatio

7stamp REST API

Saatavilla

7stamp Integration API mahdollistaa CRM, verkkokauppaalustan, POS, mukautetun taustajärjestelmän tai automaatiotyökalun hallita lompakon kanta-asiakaskortteja, joiden yhteystietotunnus on jo käytössä. Se on universaali vaihtoehto, kun erikoistunutta integraatiota ei ole olemassa.

API-kanta URL on https://api.7loc.com/cards-api. Todenna jokainen pyyntö avaimella API tunnuksena Bearer. Käytä linkitettyä viitettä OpenAPI live-pyyntö- ja vastausskeemoille ennen tuotantologiikan rakentamista.

Mitä voit tehdä numerolla API

API on integrointipinon kirjoituspuoli. Käytä sitä aina, kun oman ohjelmistosi pitäisi pysyä toimivana totuuden lähteenä, kun taas 7stamp hoitaa lompakon uskollisuustason.

Myönnä kortteja omasta ohjelmistostasi

Luo henkilökohtainen lompakkokorttilinkki mille tahansa asiakkaalle järjestelmässäsi. Toimita se omalla sähköpostilla, numerolla 20926⟧, push-toiminnolla tai sovelluksen sisäisellä kulkuyhteydellä. Asiakas avaa linkin ja tallentaa kortin numeroon Apple Wallet tai Google Wallet.

Luottoleimat mistä tahansa lähteestä

Kun osto päättyy mukautetussa numerossa POS, kun verkkotilaus maksetaan verkkosivustollasi tai kun palvelu on suoritettu varausjärjestelmässäsi, soita numeroon API hyvittääksesi leimat. Kortti päivittyy muutamassa sekunnissa.

Hallitse kuponkeja ja kampanjoita

Myönnä kertatosite tietylle asiakkaalle, luo kampanjavalmiita palkintovirtoja ja vedä kuponkitila takaisin järjestelmiin, jotka käsittelevät rahoitusta ja palvelun laatua.

Dokumentoidut integrointitoiminnot API

Nämä ovat julkiset reitit API toimintojen Make ja Zapier takana. Lue tarkka skeema viitteestä API; Älä päättele kenttien nimiä eri päätepisteistä.

Kortit POST /cards/invite

Luo korttikutsu

Luo uuden henkilökohtaisen asennuksen URL ulkoiselle yhteyshenkilölle.

Kortit POST /cards/invite/bulk

Luo joukkokorttikutsuja

Luo jopa 100 kutsulinkkiä valvotussa erässä.

Kortit GET /cards

Etsi kortit

Hakee korttitietueita ulkoisen yhteyshenkilön tunnisteen perusteella.

Kortit GET /cards/{user_card_id}

Hanki kortin tiedot

Palauttaa yhden kortin täyden tilan sisäisellä numerolla 7stamp ID.

Kortit POST /cards/scan

Skannaa kortti

Lisää leimat kortilla ID tai External ID ja tallentaa lähdetilauksen, kun se toimitetaan.

Mallit GET /templates

Listaa malleja

Listaa avaimen työpaikalla käytettävissä olevat korttimallit/profile.

Mallit GET /templates/{template_id}/design

Hanki mallipohja

Lukee tunnetun korttimallin visuaaliset asetukset.

Kupongit POST /vouchers/issue

Myönnä kuponki

Myöntää kupongin kortin omistajalle.

Viestit POST /messages/send

Lähetä viesti

Lähettää lompakkokortin push- ja/or sähköpostin sisällön kortin omistajalle.

Mihin API-avain luodaan ja kopioidaan

Nämä ovat todellisia 7stamp Admin-näyttöjä. Avaa API & Integraatiot, lisää avain ja kopioi se sitten suojattuun palvelinpuolen salaisuuteen tai automaatioyhteyteen.

7stamp Admin API & Integraatiot-näyttö, jossa näkyy Add API Key-painike ja Luo API Näppäindialogi
Vaihe 1 — Valitse ⟦ ⟦ 999999⟧, avaa navigointi vasemmassa 21. &009 API Keys, valitse Add API Key, valitse asianmukainen henkilöstön kirjautumistunnus ja luo avain.
7stamp Admin -valintaikkuna, jossa näkyy äskettäin luotu API-avain ja sen kopioinnin hallinta
Vaihe 2 – Kopioi uusi avain salasanojen hallintaan, palvelinpuolen salaisuuksiin tai suojattuun Make121/21013⟧-yhteyteen. Älä liitä sitä lähdekoodiin, selainsovellukseen tai tukikorttiin.

Kolme päätöstä ennen koodaamista

API avaimen laajuus

Luo avain kohtaan 7stamp Admin kohdassa API Integrations → API KeysAdd API Key. Avain kuuluu yhdelle työpaikalle/profile, joten luo erilliset avaimet kehitystä ja tuotantoa varten, kun tilisi asetukset sen sallivat. Kierrä tai peruuta käyttöoikeus kojelaudassa, jos salaisuus paljastuu.

Asiakkaan identiteetti

External ID on vakaa yhteyshenkilön tunniste järjestelmästäsi: CRM ID, asiakas ⟦20935 tai sähköpostiosoite, puhelinnumero. Suosi muuttumatonta järjestelmää ID. Lisää valinnaisesti External Source välttääksesi järjestelmien väliset törmäykset ja tehdäksesi webhook-korrelaation selväksi.

Mallin valinta

Kun profiilissa on yksi aktiivinen malli, template_id voidaan jättää pois ja 7stamp valitsee sen automaattisesti. Kun siinä on useita aktiivisia malleja, välitä tarkoitettu template_id. Lue ensin GET /templates sen sijaan, että koodaa arvattu ID.

Todennettu vähimmäispyyntö: luo kutsu

Kopioi tämä automaatiovaiheeseen 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
  }'

Avaimesta API ensimmäiseen onnistuneeseen pyyntöön

01

Kirjaudu sisään numeroon 7stamp Admin ja luo avain: ⟦21015. Tallenna se salaiseen hallintaan, älä lähdekoodiin tai asiakaspuolen sovellukseen.

02

Aseta perusarvo URL arvoon https://api.7loc.com/cards-api ja lisää Authorization: Bearer ja sen jälkeen avain jokaiseen palvelinpuolen pyyntöön.

03

Soita ensin numeroon GET /templates. Onnistunut vastaus vahvistaa tunnuksen ja näyttää kyseiselle työpaikalle saatavilla olevat mallit/profile.

04

Valitse omasta järjestelmästäsi vakaa External ID ja valinnainen External Source. Käytä täsmälleen samaa identiteettiparia luonti-, skannaus-, haku- ja webhook-logiikassa.

05

Soita numeroon POST /cards/invite kertakäyttöisellä testikontaktilla. Tarkista palautettu asennus URL ennen kuin automatisoit toimituksen todellisille asiakkaille.

06

Lisää POST /cards/scan-, kuponki- tai viestitoimintoja vasta, kun sinulla on kirjaaminen, virheiden käsittely ja turvallinen uudelleenyritys/idempotency-strategia omassa taustajärjestelmässäsi.

Käytä viitettä API sopimuksena

Julkinen Swagger/OpenAPI-viite sisältää nykyiset päätepiste-, parametri-, pyyntörunko-, vastaus- ja webhook-skeemat. Interaktiivinen URL on https://api.7loc.com/cards-api/docs ja koneellisesti luettava sopimus on https://api.7loc.com/cards-api/openapi.json. Lue se ennen virheenkäsittelyn käyttöönottoa tai valinnaisten kenttien lisäämistä.

Todennus ja avainten turvallisuus

Avain on palvelinpuolen salaisuus. Älä paljasta sitä selaimen JavaScriptissä, mobiilisovelluspaketissa, julkisessa lomakkeessa, kuvakaappauksissa, Make/Zapier tekstikentissä tai tukilipuissa. Käytä palvelinta, suojattua automaatioyhteyttä tai salaista hallintaa. Jos avain jaetaan joskus vahingossa, peruuta tai käännä se kohdassa 7stamp Admin ja päivitä kyseinen yhteys.

Usein kysytyt kysymykset

Mistä saan tunnuksen 7stamp API?

Siirry kohtaan 7stamp Admin osoitteeseen API Integrations → API Keys → Add API Key. Tunnus lähetetään sitten Authorization-otsikossa muodossa Bearer, jota seuraa avain.

Mikä on perustunnus URL ja todennusmenetelmä?

Käytä numeroa https://api.7loc.com/cards-api ja lähetä Authorization: Bearer YOUR_7STAMP_API_KEY jokaisessa valtuutetussa pyynnössä.

Milloin voin jättää pois template_id?

Vain kun yhdistetyssä profiilissa on täsmälleen yksi aktiivinen korttimalli. Jos useita malleja on aktiivisia, valitse oikea template_id kohdasta GET /templates.

Pitäisikö minun käyttää numeroa API, Make vai Zapier?

Käytä koodia API mukautetun POS-, tausta-, sivusto- tai täyden hallinnan luomiseen. Käytä numeroa Make visuaalisiin haarautumisskenaarioihin. Käytä numeroa Zapier enimmäkseen lineaariseen laukaisutoimintojen työnkulkuun. Kaikki kolme luottavat samaan avaimeen API ja sopimukseen API.

Seuraava askel

Testaa ensin pienin turvallinen API virtaus

Luo avain, soita numeroon GET /templates, luo yksi kutsu kertakäyttöiselle yhteyshenkilölle ja lisää sitten tuotantosalaisuudet, lokikirjaukset, uudelleenyritykset ja webhook-käsittely todistetun pyynnön ympärille.