Pagsasama ng developer

7stamp REST API

Available

Ang 7stamp Integration API ay nagbibigay-daan sa isang CRM, ecommerce platform, POS, custom na backend, o automation tool na pamahalaan ang mga wallet loyalty card gamit ang contact identifier na ginagamit na ng sarili mong system. Ito ang unibersal na opsyon kapag ang isang dalubhasang pagsasama ay walang umiiral.

Ang API base URL ay https://api.7loc.com/cards-api. I-authenticate ang bawat kahilingan gamit ang API key bilang Bearer token. Gamitin ang naka-link na OpenAPI reference para sa live na kahilingan at mga schema ng pagtugon bago bumuo ng lohika ng produksyon.

Ano ang magagawa mo sa API

Ang API ay ang write side ng integration stack. Gamitin ito sa tuwing ang iyong sariling software ay dapat manatili sa pagpapatakbong pinagmumulan ng katotohanan habang pinangangasiwaan ng 7stamp ang wallet loyalty layer.

Mag-isyu ng mga card mula sa sarili mong software

Bumuo ng link ng personal na wallet card para sa sinumang customer sa iyong system. Ihatid ito sa pamamagitan ng sarili mong email, SMS, push, o in-app na daloy. Binuksan ng customer ang link at ise-save ang card sa Apple Wallet o Google Wallet.

Mga credit stamp mula sa anumang pinagmulan

Kapag ang isang pagbili ay nagsara sa iyong custom na POS, kapag ang isang online na order ay binayaran sa iyong website, o kapag ang isang serbisyo ay nakumpleto sa iyong booking system, tawagan ang API sa mga credit stamp. Nag-a-update ang card sa loob ng ilang segundo.

Pamahalaan ang mga voucher at kampanya

Mag-isyu ng one-off na voucher sa isang partikular na customer, gumawa ng mga daloy ng reward na handa sa kampanya, at ibalik ang status ng voucher sa mga system na humahawak sa pananalapi at kalidad ng serbisyo.

Documented Integration API operations

Ito ang mga pampublikong API ruta sa likod ng Make at Zapier na mga aksyon. Basahin ang eksaktong schema sa API reference; huwag maghinuha ng mga pangalan ng field mula sa ibang endpoint.

Mga kard POST /cards/invite

Gumawa ng imbitasyon sa card

Gumagawa ng bagong personal na pag-install URL para sa isang panlabas na contact.

Mga kard POST /cards/invite/bulk

Maramihang gumawa ng mga imbitasyon sa card

Lumilikha ng hanggang 100 link ng imbitasyon sa isang kinokontrol na batch.

Mga kard GET /cards

Maghanap ng mga card

Hinahanap ang mga tala ng card sa pamamagitan ng external na contact identifier.

Mga kard GET /cards/{user_card_id}

Kunin ang detalye ng card

Ibinabalik ang buong estado ng isang card sa pamamagitan ng panloob na 7stamp ID.

Mga kard POST /cards/scan

Mag-scan ng card

Nagdaragdag ng mga selyo sa pamamagitan ng card ID o External ID at itinatala ang source order kapag ibinigay.

Mga template GET /templates

Listahan ng mga template

Naglilista ng mga template ng card na available sa lugar ng trabaho ng susi/profile.

Mga template GET /templates/{template_id}/design

Kumuha ng disenyo ng template

Nagbabasa ng mga visual na setting para sa isang kilalang template ng card.

Mga voucher POST /vouchers/issue

Mag-isyu ng voucher

Nagbibigay ng voucher sa isang may-ari ng card.

Mga Mensahe POST /messages/send

Magpadala ng mensahe

Nagpapadala ng wallet-card push at/or email na nilalaman sa isang may-ari ng card.

Saan gagawa at kopyahin ang API key

Ito ay mga tunay na 7stamp Admin na screen. Buksan ang API & Integrations, magdagdag ng key, pagkatapos ay kopyahin ito sa isang secure na server-side secret o automation na koneksyon.

7stamp Admin API & Integrations screen na nagpapakita ng Add API Key button at Bumuo ng API Key dialog
Hakbang 1 na natitira — Piliin ang ⟦1049 na navigation API Keys, piliin ang Add API Key, piliin ang naaangkop na login ng staff, at buuin ang key.
7stamp Admin dialog na nagpapakita ng bagong nabuong API key at ang copy control nito
Step 2 — Copy the new key into a password manager, server-side secret, or secure Make/Zapier connection. Do not paste it into source code, a browser application, or a support ticket.

Tatlong desisyon na dapat gawin bago mag-coding

API pangunahing saklaw

Gawin ang susi sa 7stamp Admin sa ilalim ng API Integrations → API KeysAdd API Key. Ang isang susi ay pag-aari sa isang lugar ng trabaho/profile, kaya gumawa ng hiwalay na mga susi para sa pag-unlad at produksyon kapag pinapayagan ito ng iyong pag-setup ng account. I-rotate o bawiin ang access mula sa dashboard kung may nalantad na lihim.

Pagkakakilanlan ng customer

Ang External ID ay ang stable na contact identifier mula sa iyong system: isang CRM ID, customer UUID, numero ng telepono, o email. Mas gusto ang isang hindi nababagong sistema ID. Opsyonal na idagdag ang External Source upang maiwasan ang mga banggaan sa mga system at upang gawing tahasan ang ugnayan ng webhook.

Pagpili ng template

Kapag ang profile ay may isang aktibong template, template_id maaaring tanggalin at 7stamp ito ay awtomatikong pipiliin. Kapag marami itong aktibong template, ipasa ang nilalayong template_id. Basahin muna ang GET /templates sa halip na mag-hard-coding ng nahulaan na ID.

Minimal na na-authenticate na kahilingan: gumawa ng imbitasyon

Kopyahin ito sa iyong hakbang sa automation 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
  }'

Mula API susi hanggang sa unang matagumpay na kahilingan

01

Mag-sign in sa 7stamp Admin at gumawa ng susi: ⟦10499. I-store ito sa iyong secret manager, hindi source code o isang client-side application.

02

Itakda ang base URL sa https://api.7loc.com/cards-api at idagdag ang Authorization: Bearer na sinusundan ng susi sa bawat kahilingan sa panig ng server.

03

Tawagan muna ang GET /templates. Kinukumpirma ng matagumpay na tugon ang token at ipinapakita ang mga template na available sa lugar ng trabahong iyon/profile.

04

Piliin ang stable External ID at opsyonal External Source mula sa sarili mong system. Gamitin ang eksaktong parehong pares ng pagkakakilanlan sa paglikha, pag-scan, paghahanap, at lohika ng webhook.

05

Tumawag sa POST /cards/invite gamit ang disposable test contact. I-verify ang ibinalik na pag-install URL bago i-automate ang paghahatid sa mga tunay na customer.

06

Magdagdag lamang ng POST /cards/scan, voucher, o mga aksyon sa mensahe pagkatapos mong mag-log, paghawak ng error, at ligtas na muling subukang/idempotency na diskarte sa sarili mong backend.

Gamitin ang API reference bilang kontrata

Ang pampublikong Swagger/OpenAPI reference ay naglalaman ng kasalukuyang endpoint, parameter, request-body, tugon, at webhook schemas. Ang interactive na URL ay https://api.7loc.com/cards-api/docs at ang machine-readable na kontrata ay https://api.7loc.com/cards-api/openapi.json. Basahin ito bago ipatupad ang paghawak ng error o magdagdag ng mga opsyonal na field.

Authentication at pangunahing kaligtasan

Ang susi ay isang lihim sa panig ng server. Huwag ilantad ito sa browser JavaScript, isang mobile app bundle, isang pampublikong form, mga screenshot, Make/Zapier text field, o support ticket. Gumamit ng server, secure na koneksyon sa automation, o secret manager. Kung hindi sinasadyang naibahagi ang susi, bawiin o i-rotate ito sa 7stamp Admin at i-update ang apektadong koneksyon.

Mga madalas itanong

Saan ako makakakuha ng 7stamp API token?

Sa 7stamp Admin, pumunta sa API Integrations → API Keys → Add API Key. Ang token ay ipapadala sa Authorization header bilang Bearer na sinusundan ng susi.

Ano ang base URL at paraan ng pagpapatunay?

Gamitin ang https://api.7loc.com/cards-api at ipadala ang Authorization: Bearer YOUR_7STAMP_API_KEY sa bawat awtorisadong kahilingan.

Kailan ko maaaring alisin ang template_id?

Lamang kapag ang konektadong profile ay may eksaktong isang aktibong template ng card. Kung maraming template ang aktibo, piliin ang tamang template_id mula sa GET /templates.

Dapat ko bang gamitin ang API, Make, o ⟦10?

Gamitin ang API para sa custom na POS, backend, site, o ganap na kontrol. Gamitin ang Make para sa mga visual branching na sitwasyon. Gamitin ang Zapier para sa halos linear na trigger-action na daloy ng trabaho. Ang tatlo ay umaasa sa parehong API susi at API kontrata.

Susunod na hakbang

Subukan muna ang pinakamaliit na ligtas API daloy

Lumikha ng susi, tumawag sa GET /templates, gumawa ng isang imbitasyon para sa isang disposable contact, pagkatapos ay magdagdag ng mga lihim ng produksyon, pag-log, muling pagsubok, at pangangasiwa sa webhook tungkol sa napatunayang kahilingan.