Izstrādātāju integrācija

7stamp REST API

Pieejams

7stamp Integration API ļauj CRM, e-komercijas platformai, POS, pielāgotai aizmugursistēmai vai automatizācijas rīkam pārvaldīt maka lojalitātes kartes ar kontaktpersonas identifikatoru, ko jau izmanto jūsu sistēma. Tā ir universāla iespēja, ja nepastāv specializēta integrācija.

API ​​bāze URL ir https://api.7loc.com/cards-api. Autentificējiet katru pieprasījumu, izmantojot atslēgu API kā marķieri Bearer. Pirms ražošanas loģikas izveides izmantojiet saistīto OpenAPI atsauci tiešsaistes pieprasījumu un atbilžu shēmām.

Ko jūs varat darīt ar API

API ir integrācijas steka rakstīšanas puse. Izmantojiet to ikreiz, kad jūsu programmatūrai vajadzētu palikt par darbības patiesības avotu, kamēr 7stamp apstrādā maka lojalitātes slāni.

Izsniedziet kartes no savas programmatūras

Generate a personal wallet card link for any customer in your system. Piegādājiet to, izmantojot savu e-pastu, 26662⟧, push vai lietotnes plūsmu. Klients atver saiti un saglabā karti uz Apple Wallet vai Google Wallet.

Kredītzīmogi no jebkura avota

Kad pirkums tiek slēgts jūsu pielāgotajā POS, kad tiešsaistes pasūtījums tiek apmaksāts jūsu vietnē vai pakalpojums ir pabeigts jūsu rezervēšanas sistēmā, zvaniet pa tālruni API, lai iegūtu kredītzīmogus. Karte tiek atjaunināta dažu sekunžu laikā.

Pārvaldiet kuponus un kampaņas

Izsniedziet vienreizēju kuponu konkrētam klientam, izveidojiet kampaņām gatavas atlīdzības plūsmas un atgrieziet kupona statusu sistēmās, kas pārvalda finanšu un pakalpojumu kvalitāti.

Dokumentētas integrācijas API darbības

Šie ir publiskie API maršruti aiz darbībām Make un Zapier. Izlasiet precīzu shēmu atsaucē API; neseciniet lauku nosaukumus no cita galapunkta.

Kartes POST /cards/invite

Izveidojiet uzaicinājumu uz karti

Izveido jaunu personīgo instalāciju URL ārējam kontaktam.

Kartes POST /cards/invite/bulk

Lielapjoma izveidojiet kartīšu ielūgumus

Izveido līdz 100 uzaicinājuma saitēm kontrolētā grupā.

Kartes GET /cards

Atrodiet kartes

Meklē karšu ierakstus pēc ārējā kontakta identifikatora.

Kartes GET /cards/{user_card_id}

Iegūstiet kartes informāciju

Atgriež pilnu vienas kartes stāvokli ar tās iekšējo 7stamp ID.

Kartes POST /cards/scan

Skenējiet karti

Pievieno zīmogus ar karti ID vai External ID un reģistrē avota pasūtījumu, kad tas tiek piegādāts.

Veidnes GET /templates

Saraksta veidnes

Uzskaita atslēgas darba vietai pieejamās karšu veidnes/profile.

Veidnes GET /templates/{template_id}/design

Iegūstiet veidnes dizainu

Nolasa vizuālos iestatījumus zināmai kartes veidnei.

Vaučeri POST /vouchers/issue

Izsniedziet kuponu

Izsniedz kartes īpašniekam kuponu.

Ziņas POST /messages/send

Sūtīt ziņojumu

Nosūta kartes īpašniekam maka kartes informatīvo un/or e-pasta saturu.

Kur izveidot un kopēt taustiņu API

Šie ir īsti 7stamp Admin ekrāni. Atveriet API un integrācijas, pievienojiet atslēgu un pēc tam kopējiet to drošā servera puses slepenajā vai automatizācijas savienojumā.

7stamp Admin API un integrācijas ekrāns, kurā ir redzama poga Add API Key un Ģenerēt API taustiņu dialoglodziņš
1. darbība — atveriet ⟧ kreiso navigāciju un 7 integrācijas. API Keys, izvēlieties Add API Key, atlasiet atbilstošo personāla pieteikumvārdu un ģenerējiet atslēgu.
7stamp Admin dialoglodziņš, kurā tiek parādīta tikko ģenerēta atslēga API un tās kopēšanas vadība
2. darbība. Kopējiet jauno atslēgu paroļu pārvaldniekā, servera puses noslēpumā vai drošā ⟦26749⦟26/48⟧ savienojumā. Neielīmējiet to pirmkodā, pārlūkprogrammas lietojumprogrammā vai atbalsta biļetē.

Trīs lēmumi, kas jāpieņem pirms kodēšanas

API atslēgas darbības joma

Izveidojiet atslēgu laukā 7stamp Admin zem API Integrations → API KeysAdd API Key. Atslēga pieder vienai darba vietai/profile, tāpēc izveidojiet atsevišķas atslēgas izstrādei un ražošanai, kad to atļauj jūsu konta iestatīšana. Pagrieziet vai atsauciet piekļuvi informācijas panelim, ja tiek atklāts kāds noslēpums.

Klienta identitāte

External ID ir stabils kontaktpersonas identifikators no jūsu sistēmas: CRM ID, klienta ⟦26671 vai e-pasts, tālruņa numurs. Dodiet priekšroku nemainīgai sistēmai ID. Pēc izvēles pievienojiet External Source, lai izvairītos no sadursmēm starp sistēmām un lai tīmekļa aizķeres korelācija būtu skaidra.

Veidņu izvēle

Ja profilam ir viena aktīva veidne, template_id var izlaist un 7stamp to atlasa automātiski. Ja tam ir vairākas aktīvas veidnes, nododiet paredzēto template_id. Vispirms izlasiet GET /templates, nevis stingri iekodējiet uzminēto ID.

Minimāls autentificēts pieprasījums: izveidojiet uzaicinājumu

Kopējiet to savā automatizācijas darbībā 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
  }'

No atslēgas API līdz pirmajam veiksmīgajam pieprasījumam

01

Pierakstieties uz 7stamp Admin un izveidojiet atslēgu: API Integrations → API KeysAdd API Key. Saglabājiet to savā slepenajā pārvaldniekā, nevis avota kodā vai klienta puses lietojumprogrammā.

02

Iestatiet bāzi URL uz https://api.7loc.com/cards-api un katram servera pieprasījumam pievienojiet Authorization: Bearer, kam seko atslēga.

03

Vispirms zvaniet GET /templates. Veiksmīga atbilde apstiprina marķieri un parāda šai darba vietai pieejamās veidnes/profile.

04

Izvēlieties stabilo External ID un izvēles External Source no savas sistēmas. Izmantojiet tieši to pašu identitātes pāri izveides, skenēšanas, uzmeklēšanas un tīmekļa aizķeres loģikā.

05

Zvaniet POST /cards/invite, izmantojot vienreiz lietojamo testa kontaktu. Pirms automatizēt piegādes reāliem klientiem pārbaudiet atgriezto instalāciju URL.

06

Pievienojiet POST /cards/scan, kuponu vai ziņojumu darbības tikai pēc reģistrēšanas, kļūdu apstrādes un drošas atkārtošanas stratēģijas/idempotency savā aizmugursistēmā.

Izmantojiet atsauci API kā līgumu

Publiskā atsauce Swagger/OpenAPI satur pašreizējā galapunkta, parametra, pieprasījuma pamatteksta, atbildes un tīmekļa aizķeres shēmas. Interaktīvais URL ir https://api.7loc.com/cards-api/docs, un mašīnlasāmais līgums ir https://api.7loc.com/cards-api/openapi.json. Izlasiet to pirms kļūdu apstrādes ieviešanas vai izvēles lauku pievienošanas.

Autentifikācija un atslēgu drošība

Atslēga ir servera puses noslēpums. Neatklājiet to pārlūkprogrammas JavaScript, mobilo lietotņu komplektā, publiskā veidlapā, ekrānuzņēmumos, teksta laukos Make/Zapier vai atbalsta biļetēs. Izmantojiet serveri, drošu automatizācijas savienojumu vai slepeno pārvaldnieku. Ja atslēga kādreiz tiek nejauši kopīgota, atsauciet vai pagrieziet to 7stamp Admin un atjauniniet ietekmēto savienojumu.

Bieži uzdotie jautājumi

Kur es varu iegūt 7stamp API marķieri?

Sadaļā 7stamp Admin dodieties uz API Integrations → API Keys → Add API Key. Pēc tam marķieris tiek nosūtīts galvenē Authorization kā Bearer, kam seko atslēga.

Kas ir bāze URL un autentifikācijas metode?

Izmantojiet https://api.7loc.com/cards-api un nosūtiet Authorization: Bearer YOUR_7STAMP_API_KEY katram autorizētajam pieprasījumam.

Kad es varu izlaist template_id?

Tikai tad, ja pievienotajam profilam ir tieši viena aktīva kartes veidne. Ja ir aktīvas vairākas veidnes, atlasiet pareizo template_id no GET /templates.

Vai man vajadzētu izmantot API, Make vai Zapier?

Izmantojiet API, lai iegūtu pielāgotu POS, aizmugursistēmu, vietni vai pilnu vadību. Vizuālas sazarošanas scenārijiem izmantojiet Make. Izmantojiet Zapier galvenokārt lineārai aktivizētāja darbību darbplūsmai. Visi trīs paļaujas uz vienu un to pašu atslēgu API un līgumu API.

Nākamais solis

Vispirms pārbaudiet mazāko drošo API plūsmu

Izveidojiet atslēgu, zvaniet GET /templates, izveidojiet vienu uzaicinājumu vienreizējai kontaktpersonai, pēc tam pievienojiet ražošanas noslēpumus, reģistrēšanu, atkārtotus mēģinājumus un tīmekļa aizķeres apstrādi atbilstoši pārbaudītajam pieprasījumam.