Arendaja integreerimine

7stamp REST API

Saadaval

7stamp Integration API võimaldab CRM, e-kaubanduse platvormil, POS, kohandatud taustaprogrammil või automatiseerimistööriistal hallata rahakoti püsikliendikaarte kontakti identifikaatoriga, mida teie süsteem juba kasutab. See on universaalne valik, kui spetsiaalset integratsiooni ei eksisteeri.

API alus URL on https://api.7loc.com/cards-api. Autentige iga päring võtmega API märgina Bearer. Enne tootmisloogika loomist kasutage reaalajas päringu- ja vastuseskeemide jaoks lingitud viidet OpenAPI.

Mida saate numbriga API teha

API on integreerimispinu kirjutamispool. Kasutage seda alati, kui teie enda tarkvara peaks jääma toimivaks tõeallikaks, samal ajal kui 7stamp tegeleb rahakoti lojaalsuskihiga.

Väljasta kaarte oma tarkvarast

Looge oma süsteemi mis tahes kliendi jaoks isiklik rahakotikaardi link. Edastage see oma meili, SMS, push-i või rakendusesisese voo kaudu. Klient avab lingi ja salvestab kaardi numbrile Apple Wallet või Google Wallet.

Krediitmargid mis tahes allikast

Kui teie kohandatud numbril POS ost suletakse, kui veebitellimuse eest tasutakse teie veebisaidil või kui teenus on teie broneerimissüsteemis lõpetatud, helistage krediittemplite saamiseks numbril API. Kaarti värskendatakse mõne sekundi jooksul.

Vautšerite ja kampaaniate haldamine

Väljastage konkreetsele kliendile ühekordne vautšer, looge kampaaniaks valmis preemiavoogusid ja viige vautšeri olek tagasi süsteemidesse, mis haldavad finants- ja teenusekvaliteeti.

Dokumenteeritud integratsiooni API toimingud

Need on avalikud marsruudid API toimingute Make ja Zapier taga. Lugege täpset skeemi viites API; ära tuleta väljanimesid erinevast lõpp-punktist.

Kaardid POST /cards/invite

Looge kaardikutse

Loob välise kontakti jaoks värske isikliku installi URL.

Kaardid POST /cards/invite/bulk

Kaardikutsete hulgiloomine

Loob kontrollitud partiina kuni 100 kutselinki.

Kaardid GET /cards

Otsige kaarte

Otsib kaardi kirjeid välise kontakti identifikaatori järgi.

Kaardid GET /cards/{user_card_id}

Hankige kaardi üksikasjad

Tagastab ühe kaardi täieliku oleku selle sisemise numbri 7stamp ID järgi.

Kaardid POST /cards/scan

Skannige kaarti

Lisab templid kaardiga ID või External ID ja salvestab tarnimisel lähtejärjekorra.

Mallid GET /templates

Loendi mallid

Loetleb võtme töökohas saadaolevad kaardimallid/profile.

Mallid GET /templates/{template_id}/design

Hankige malli kujundus

Loeb teadaoleva kaardimalli visuaalseid sätteid.

Vautšerid POST /vouchers/issue

Väljasta vautšer

Väljastab kaardi omanikule vautšeri.

Sõnumid POST /messages/send

Saada sõnum

Saadab kaardi omanikule rahakotikaardi tõuke- ja /or meilisõnumi.

Kust klahvi API luua ja kopeerida

Need on tõelised 7stamp Admin ekraanid. Avage API & Integratsioonid, lisage võti ja seejärel kopeerige see turvalisse serveripoolsesse sala- või automatiseerimisühendusse.

7stamp Admin API & Integratsiooniekraan, kus kuvatakse nupp Add API Key ja Loo API klahvidialoog
. API Keys, valige Add API Key, valige sobiv personali sisselogimine ja genereerige võti.
7stamp Admin dialoog, mis näitab äsja loodud võtit API ja selle kopeerimise juhtelementi
2. samm – kopeerige uus võti paroolihaldurisse, serveripoolsesse salajasse või turvalisesse ⟦9541⟦9540/⟟-ühendusse. Ärge kleepige seda lähtekoodi, brauserirakendusse ega tugipiletisse.

Enne kodeerimist tuleb teha kolm otsust

API võtme ulatus

Looge võti jaotises 7stamp Admin jaotises API Integrations → API KeysAdd API Key. Võti kuulub ühele töökohale/profile, seega looge arenduseks ja tootmiseks eraldi võtmed, kui teie konto seadistus seda võimaldab. Pöörake või tühistage juurdepääs armatuurlaual, kui saladus paljastatakse.

Kliendi identiteet

External ID on teie süsteemi stabiilne kontakti identifikaator: CRM ID, klient UUID, telefoninumber või e-posti aadress. Eelista muutumatut süsteemi ID. Soovi korral lisage External Source, et vältida süsteemide kokkupõrkeid ja muuta veebihaagi korrelatsioon selgesõnaliseks.

Malli valimine

Kui profiilil on üks aktiivne mall, saab template_id ära jätta ja 7stamp valib selle automaatselt. Kui sellel on mitu aktiivset malli, edastage mõeldud template_id. Lugege esmalt GET /templates, selle asemel, et arvatud ID kõvasti kodeerida.

Minimaalne autentitud taotlus: looge kutse

Kopeerige see oma automatiseerimisetappi 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
  }'

Alates API võtmest kuni esimese eduka päringuni

01

Logige sisse numbrile 7stamp Admin ja looge võti: API Integrations → API KeysAdd API Key. Salvestage see oma salahaldurisse, mitte lähtekoodi või kliendipoolsesse rakendusse.

02

Määrake baasi URL väärtuseks https://api.7loc.com/cards-api ja lisage igale serveripoolsele päringule Authorization: Bearer, millele järgneb võti.

03

Esmalt helistage numbril GET /templates. Edukas vastus kinnitab märgi ja näitab selle töökoha jaoks saadaolevaid malle/profile.

04

Valige oma süsteemist stabiilne External ID ja valikuline External Source. Kasutage loomise, skannimise, otsimise ja veebihaagi loogikas täpselt sama identiteedipaari.

05

Helistage numbril POST /cards/invite ühekordselt kasutatava testkontaktiga. Enne tegelikele klientidele tarnimise automatiseerimist kontrollige tagastatud installinumbrit URL.

06

Lisage POST /cards/scan, vautšeri või sõnumitoimingud alles pärast seda, kui teil on oma taustaprogrammis logimis-, veakäsitlus- ja ohutu uuesti proovimise strateegia/idempotency.

Kasutage lepinguna viidet API

Avalik viide Swagger/OpenAPI sisaldab praeguse lõpp-punkti, parameetri, päringu keha, vastuse ja veebihaagi skeeme. Interaktiivne URL on https://api.7loc.com/cards-api/docs ja masinloetav leping on https://api.7loc.com/cards-api/openapi.json. Lugege seda enne veakäsitluse rakendamist või valikuliste väljade lisamist.

Autentimine ja võtme turvalisus

Võti on serveripoolne saladus. Ärge avaldage seda brauseri JavaScriptis, mobiilirakenduse paketis, avalikus vormis, ekraanipiltides, Make/Zapier tekstiväljades ega tugipiletites. Kasutage serverit, turvalist automatiseerimisühendust või salahaldurit. Kui võtit kogemata jagatakse, tühistage või pöörake see dokumendis 7stamp Admin ja värskendage mõjutatud ühendust.

Korduma kippuvad küsimused

Kust saada märgi 7stamp API?

Dokumendis 7stamp Admin minge aadressile API Integrations → API Keys → Add API Key. Seejärel saadetakse märk päises Authorization kui Bearer, millele järgneb võti.

Mis on põhikood URL ja autentimismeetod?

Kasutage numbrit https://api.7loc.com/cards-api ja saatke iga volitatud päringu puhul Authorization: Bearer YOUR_7STAMP_API_KEY.

Millal võin numbri template_id välja jätta?

Ainult siis, kui ühendatud profiilil on täpselt üks aktiivne kaardimall. Kui aktiivne on mitu malli, valige õige template_id hulgast GET /templates.

Kas ma peaksin kasutama numbrit API, Make või Zapier?

Kasutage numbrit API kohandatud POS, taustaprogrammi, saidi või täieliku juhtimise jaoks. Visuaalse hargnemise stsenaariumide jaoks kasutage numbrit Make. Kasutage Zapier ​​enamasti lineaarse käivitustoimingu töövoo jaoks. Kõik kolm toetuvad samale võtmele API ja lepingule API.

Järgmine samm

Kõigepealt testige väikseimat turvalist API voolu

Looge võti, helistage numbril GET /templates, looge üks kutse ühekordselt kasutatavale kontaktile, seejärel lisage tõestatud päringu ümber tootmisesaladused, logimine, korduskatsetused ja veebihaagi käsitlemine.