Penyepaduan pembangun

7stamp REST API

Tersedia

7stamp Integration API membolehkan CRM, platform e-dagang, POS, hujung belakang tersuai atau alat automasi mengurus kad kesetiaan dompet dengan pengecam kenalan yang telah digunakan oleh sistem anda sendiri. Ia adalah pilihan universal apabila integrasi khusus tidak wujud.

API asas URL ialah https://api.7loc.com/cards-api. Sahkan setiap permintaan dengan kunci API sebagai token Bearer. Gunakan rujukan OpenAPI yang dipautkan untuk permintaan langsung dan skema respons sebelum membina logik pengeluaran.

Apa yang boleh anda lakukan dengan API

API ialah bahagian tulis bagi timbunan penyepaduan. Gunakannya pada bila-bila masa perisian anda sendiri harus kekal sebagai sumber operasi kebenaran sementara 7stamp mengendalikan lapisan kesetiaan dompet.

Keluarkan kad daripada perisian anda sendiri

Hasilkan pautan kad dompet peribadi untuk mana-mana pelanggan dalam sistem anda. Hantarkannya melalui e-mel anda sendiri, SMS, tolak atau aliran dalam apl. Pelanggan membuka pautan dan menyimpan kad ke Apple Wallet atau Google Wallet.

Setem kredit daripada mana-mana sumber

Apabila pembelian ditutup dalam adat anda POS, apabila pesanan dalam talian dibayar di tapak web anda, atau apabila perkhidmatan selesai dalam sistem tempahan anda, hubungi API untuk mendapatkan setem kredit. Kad dikemas kini dalam beberapa saat.

Urus baucar dan kempen

Keluarkan baucar sekali sahaja kepada pelanggan tertentu, buat aliran ganjaran sedia kempen dan tarik semula status baucar ke dalam sistem yang mengendalikan kewangan dan kualiti perkhidmatan.

Operasi Integrasi Berdokumen API

Ini ialah laluan awam API di sebalik tindakan Make dan Zapier. Baca skema tepat dalam rujukan API; jangan membuat kesimpulan nama medan daripada titik akhir yang berbeza.

Kad POST /cards/invite

Buat jemputan kad

Mencipta pemasangan peribadi baharu URL untuk kenalan luaran.

Kad POST /cards/invite/bulk

Jemputan kad buat pukal

Mencipta sehingga 100 pautan jemputan dalam kelompok terkawal.

Kad GET /cards

Cari kad

Mencari rekod kad oleh pengecam kenalan luaran.

Kad GET /cards/{user_card_id}

Dapatkan butiran kad

Mengembalikan keadaan penuh satu kad dengan 7stamp ID dalamannya.

Kad POST /cards/scan

Imbas kad

Menambahkan setem dengan kad ID atau External ID dan merekodkan pesanan sumber apabila dibekalkan.

templat GET /templates

Senaraikan templat

Menyenaraikan templat kad yang tersedia di tempat kerja kunci/profile.

templat GET /templates/{template_id}/design

Dapatkan reka bentuk templat

Membaca tetapan visual untuk templat kad yang diketahui.

baucar POST /vouchers/issue

Mengeluarkan baucar

Mengeluarkan baucar kepada pemilik kad.

Mesej POST /messages/send

Hantar mesej

Menghantar tolak kad dompet dan/or kandungan e-mel kepada pemilik kad.

Tempat untuk mencipta dan menyalin kekunci API

Ini adalah skrin 7stamp Admin sebenar. Buka API & Integrasi, tambah kunci, kemudian salin ke dalam rahsia bahagian pelayan yang selamat atau sambungan automasi.

7stamp Admin API & Skrin Integrasi menunjukkan butang Add API Key dan Jana API Dialog kekunci
Langkah 1 — Pilih ⟦ &1889⟧ navigasi di sebelah kiri API Keys, pilih Add API Key, pilih log masuk kakitangan yang sesuai, dan jana kunci.
7stamp Admin dialog menunjukkan kekunci API yang baru dijana dan kawalan salinannya
Langkah 2 — Salin kekunci baharu ke dalam pengurus kata laluan, rahsia bahagian pelayan atau selamatkan sambungan Make92⟦ Jangan tampalkannya ke dalam kod sumber, aplikasi penyemak imbas atau tiket sokongan.

Tiga keputusan yang perlu dibuat sebelum pengekodan

API skop kunci

Cipta kunci dalam 7stamp Admin di bawah API Integrations → API KeysAdd API Key. Kunci kepunyaan satu tempat kerja/profile, jadi buat kunci berasingan untuk pembangunan dan pengeluaran apabila persediaan akaun anda membenarkannya. Putar atau batalkan akses daripada papan pemuka jika rahsia terdedah.

Identiti pelanggan

External ID ialah pengecam kenalan yang stabil daripada sistem anda: a CRM ID, pelanggan UUID, nombor telefon atau e-mel. Lebih suka sistem tidak berubah ID. Tambah External Source secara pilihan untuk mengelakkan perlanggaran merentas sistem dan untuk menjadikan korelasi webhook jelas.

Pemilihan templat

Apabila profil mempunyai satu templat aktif, template_id boleh ditinggalkan dan 7stamp memilihnya secara automatik. Apabila ia mempunyai berbilang templat aktif, lulus template_id yang dimaksudkan. Baca GET /templates dahulu daripada mengekod keras ID yang diteka.

Permintaan disahkan minimum: buat jemputan

Salin ini ke dalam langkah automasi anda 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
  }'

Dari kunci API kepada permintaan pertama yang berjaya

01

Log masuk ke 7stamp Admin dan buat kunci: API Integrations → API KeysAdd API Key. Simpannya dalam pengurus rahsia anda, bukan kod sumber atau aplikasi sebelah pelanggan.

02

Tetapkan asas URL kepada https://api.7loc.com/cards-api dan tambah Authorization: Bearer diikuti dengan kunci kepada setiap permintaan sebelah pelayan.

03

Hubungi GET /templates dahulu. Respons yang berjaya mengesahkan token dan menunjukkan templat yang tersedia untuk tempat kerja itu/profile.

04

Pilih stabil External ID dan External Source pilihan daripada sistem anda sendiri. Gunakan pasangan identiti yang sama dalam mencipta, mengimbas, mencari dan logik webhook.

05

Hubungi POST /cards/invite dengan kenalan ujian pakai buang. Sahkan pemasangan yang dikembalikan URL sebelum mengautomasikan penghantaran kepada pelanggan sebenar.

06

Tambah POST /cards/scan, baucar atau tindakan mesej hanya selepas anda melakukan pengelogan, pengendalian ralat dan cuba semula dengan selamat/idempotency strategi di bahagian belakang anda sendiri.

Gunakan rujukan API sebagai kontrak

Rujukan Swagger/OpenAPI awam mengandungi titik akhir, parameter, badan permintaan, respons dan skema webhook semasa. Interaktif URL ialah https://api.7loc.com/cards-api/docs dan kontrak boleh dibaca mesin ialah https://api.7loc.com/cards-api/openapi.json. Bacanya sebelum melaksanakan pengendalian ralat atau menambah medan pilihan.

Pengesahan dan keselamatan kunci

Kuncinya ialah rahsia sebelah pelayan. Jangan dedahkannya dalam JavaScript penyemak imbas, himpunan aplikasi mudah alih, borang awam, tangkapan skrin, medan teks Make/Zapier atau tiket sokongan. Gunakan pelayan, sambungan automasi selamat atau pengurus rahsia. Jika kunci pernah dikongsi secara tidak sengaja, batalkan atau putarkannya dalam 7stamp Admin dan kemas kini sambungan yang terjejas.

Soalan lazim

Di manakah saya boleh mendapatkan token 7stamp API?

Dalam 7stamp Admin, pergi ke API Integrations → API Keys → Add API Key. Token kemudiannya dihantar dalam pengepala Authorization sebagai Bearer diikuti dengan kunci.

Apakah asas URL dan kaedah pengesahan?

Gunakan https://api.7loc.com/cards-api dan hantar Authorization: Bearer YOUR_7STAMP_API_KEY pada setiap permintaan yang dibenarkan.

Bilakah saya boleh meninggalkan template_id?

Hanya apabila profil yang disambungkan mempunyai tepat satu templat kad aktif. Jika berbilang templat aktif, pilih template_id yang betul daripada GET /templates.

Perlukah saya menggunakan API, Make atau Zapier?

Gunakan API untuk POS tersuai, hujung belakang, tapak atau kawalan penuh. Gunakan Make untuk senario percabangan visual. Gunakan Zapier untuk aliran kerja tindakan pencetus yang kebanyakannya linear. Ketiga-tiganya bergantung pada kunci API dan kontrak API yang sama.

Langkah seterusnya

Uji aliran API peti keselamatan terkecil dahulu

Cipta kunci, hubungi GET /templates, buat satu jemputan untuk kenalan pakai buang, kemudian tambahkan rahsia pengeluaran, pengelogan, percubaan semula dan pengendalian webhook di sekitar permintaan yang terbukti.