Әзірлеушілерді біріктіру

7stamp REST API

Қол жетімді

7stamp Integration API CRM, электрондық коммерция платформасы, POS, пайдаланушы сервері немесе автоматтандыру құралы жеке жүйеңіз бұрыннан қолданатын контакт идентификаторы бар әмиянның адалдық карталарын басқаруға мүмкіндік береді. Мамандандырылған интеграция болмаған кезде бұл әмбебап нұсқа.

API негізі URL — https://api.7loc.com/cards-api. әрбір сұрауды Bearer белгісі ретінде API кілтімен аутентификациялаңыз. Өндіріс логикасын құру алдында тікелей сұрау және жауап схемалары үшін байланыстырылған OpenAPI анықтамасын пайдаланыңыз.

API арқылы не істеуге болады

API - біріктіру стекінің жазу жағы. 7stamp әмиянның адалдық деңгейін өңдеген кезде жеке бағдарламалық құрал шындықтың операциялық көзі болып қалатын кезде оны пайдаланыңыз.

Жеке бағдарламалық құралдан карталарды шығарыңыз

Жүйедегі кез келген тұтынушы үшін жеке әмиян картасының сілтемесін жасаңыз. Оны жеке электрондық пошта, SMS, push немесе қолданбадағы ағын арқылы жеткізіңіз. Тұтынушы сілтемені ашып, картаны Apple Wallet немесе Google Wallet нөміріне сақтайды.

Кез келген көзден алынған несиелік маркалар

Арнайы POS ішінде сатып алу жабылғанда, веб-сайтыңызда онлайн тапсырыс төленген кезде немесе брондау жүйеңізде қызмет аяқталғанда, несиелік мөрлерді алу үшін API нөміріне қоңырау шалыңыз. Карта бірнеше секунд ішінде жаңартылады.

Ваучерлер мен науқандарды басқару

Белгілі бір тұтынушыға бір реттік ваучер беріңіз, науқанға дайын сыйақы ағындарын жасаңыз және ваучер күйін қаржы мен қызмет сапасын реттейтін жүйелерге қайтарыңыз.

Құжатталған интеграция API операциялары

Бұл Make және Zapier әрекеттерінің артындағы жалпыға ортақ API маршруттары. API анықтамасындағы нақты схеманы оқыңыз; өріс атауларын басқа соңғы нүктеден шығармаңыз.

Карталар POST /cards/invite

Шақыру картасын жасаңыз

Сыртқы контакт үшін жаңа жеке орнату URL жасайды.

Карталар POST /cards/invite/bulk

Карта шақыруларын жаппай жасаңыз

Бақыланатын бумада 100 шақыру сілтемесін жасайды.

Карталар GET /cards

Карталарды табыңыз

Сыртқы контакт идентификаторы арқылы карта жазбаларын іздейді.

Карталар GET /cards/{user_card_id}

Карта мәліметтерін алыңыз

Бір картаның толық күйін ішкі 7stamp ID арқылы қайтарады.

Карталар POST /cards/scan

Картаны сканерлеңіз

ID немесе External ID картасы бойынша мөрлерді қосады және жеткізілген кезде бастапқы тапсырысты жазады.

Үлгілер GET /templates

Тізім үлгілері

Кілттің жұмыс орнында қолжетімді карта үлгілерінің тізімі/profile.

Үлгілер GET /templates/{template_id}/design

Үлгі дизайнын алыңыз

Белгілі карта үлгісі үшін көрнекі параметрлерді оқиды.

Ваучерлер POST /vouchers/issue

Ваучер беріңіз

Карта иесіне ваучер береді.

Хабарламалар POST /messages/send

Хабарлама жіберу

Карта иесіне әмиян картасын push және/or электрондық пошта мазмұнын жібереді.

API пернесін қай жерде жасауға және көшіруге болады

Бұл нағыз 7stamp Admin экрандар. API & Integrations қолданбасын ашыңыз, кілт қосыңыз, содан кейін оны қауіпсіз серверлік құпияға немесе автоматтандыру қосылымына көшіріңіз.

7stamp Admin API & Интеграциялар экраны Add API Key түймешігін және API перне жасау диалогын көрсетеді
1-қадам — Сол жақ шарлауда API & Интеграциялар тармағын таңдаңыз, API Keys ашыңыз, Add API Key таңдаңыз, сәйкес персонал логинін таңдаңыз және кілтті жасаңыз.
7stamp Admin диалогтық терезесі жаңадан жасалған API пернесін және оның көшірмелерін басқаруды көрсетеді
2-қадам — Жаңа кілтті құпия сөз реттеушісіне, сервер құпиясына немесе қауіпсіз Make/Zapier қосылымына көшіріңіз. Оны бастапқы кодқа, шолғыш қолданбасына немесе қолдау билетіне қоймаңыз.

Кодтау алдында қабылданатын үш шешім

API кілт ауқымы

7stamp Admin ішінде API Integrations → API KeysAdd API Key астында кілт жасаңыз. Кілт бір жұмыс орнына тиесілі/profile, сондықтан тіркелгіңізді орнату рұқсат еткенде әзірлеу және өндіру үшін бөлек кілттер жасаңыз. Құпия ашылған болса, бақылау тақтасынан рұқсатты бұрыңыз немесе кері қайтарыңыз.

Тұтынушының жеке куәлігі

External ID – жүйеңіздегі тұрақты контакт идентификаторы: CRM ID, тұтынушы UUID телефоны немесе телефон нөмірі, электрондық пошта. ID өзгермейтін жүйені таңдаңыз. Жүйелер арасындағы қақтығыстарды болдырмау және веб-хук корреляциясын анық ету үшін қосымша External Source қосыңыз.

Үлгі таңдау

Профильде бір белсенді үлгі болса, template_id өткізіп жіберуге болады және 7stamp оны автоматты түрде таңдайды. Оның бірнеше белсенді үлгілері болса, жоспарланған template_id өтіңіз. Болжалды ID кодтаудан гөрі алдымен GET /templates оқыңыз.

Ең аз аутентификацияланған сұрау: шақыру жасаңыз

Мұны автоматтандыру қадамыңызға көшіріңіз 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
  }'

API кілтінен бірінші сәтті сұрауға дейін

01

7stamp Admin жүйесіне кіріп, кілт жасаңыз: API Integrations → API KeysAdd API Key. Оны бастапқы кодта немесе клиенттік қолданбада емес, құпия менеджерде сақтаңыз.

02

Негізді URL мәнін https://api.7loc.com/cards-api етіп орнатыңыз және Authorization қосыңыз: Bearer содан кейін әрбір серверлік сұрауға кілт.

03

Алдымен GET /templates нөміріне қоңырау шалыңыз. Сәтті жауап таңбалауышты растайды және сол жұмыс орнында қол жетімді үлгілерді көрсетеді/profile.

04

Жеке жүйеңізден тұрақты External ID және қосымша External Source таңдаңыз. Жасау, сканерлеу, іздеу және вебхук логикасында дәл бірдей сәйкестік жұбын пайдаланыңыз.

05

Бір рет қолданылатын сынақ контактісімен POST /cards/invite нөміріне қоңырау шалыңыз. Нақты тұтынушыларға жеткізуді автоматтандыру алдында қайтарылған орнатуды URL тексеріңіз.

06

POST /cards/scan, ваучер немесе хабар әрекеттерін жеке серверде тіркеу, қателерді өңдеу және қауіпсіз қайталау/idempotency стратегиясы болғаннан кейін ғана қосыңыз.

Келісімшарт ретінде API анықтамасын пайдаланыңыз

Жалпыға ортақ Swagger/OpenAPI сілтемесі ағымдағы соңғы нүктені, параметрді, сұрау денесін, жауапты және веб-хук схемаларын қамтиды. Интерактивті URL https://api.7loc.com/cards-api/docs және машина оқылатын келісім-шарт https://api.7loc.com/cards-api/openapi.json. Қателерді өңдеуді немесе қосымша өрістерді қоспас бұрын оны оқыңыз.

Аутентификация және кілт қауіпсіздігі

Кілт серверлік құпия болып табылады. Оны JavaScript браузерінде, мобильді қолданбалар жинағында, жалпы пішінде, скриншоттарда, Make/Zapier мәтін өрістерінде немесе қолдау билеттерінде көрсетпеңіз. Серверді, қауіпсіз автоматтандыру қосылымын немесе құпия менеджерді пайдаланыңыз. Егер кілт кездейсоқ ортақ пайдаланылса, оны 7stamp Admin ішінде жойыңыз немесе бұрыңыз және зардап шеккен қосылымды жаңартыңыз.

Жиі қойылатын сұрақтар

7stamp API токенін қайдан аламын?

7stamp Admin ішінде API Integrations → API Keys → Add API Key нөміріне өтіңіз. Содан кейін таңбалауыш Authorization тақырыбына Bearer және одан кейін кілт ретінде жіберіледі.

Негізгі URL және аутентификация әдісі дегеніміз не?

Әрбір рұқсат етілген сұрау бойынша https://api.7loc.com/cards-api пайдаланыңыз және Authorization жіберіңіз: Bearer YOUR_7STAMP_API_KEY.

template_id нөмірін қашан өткізіп жіберуге болады?

Жалғанған профильде дәл бір белсенді карта үлгісі болған кезде ғана. Бірнеше үлгі белсенді болса, GET /templates.

Should I use the API, Make, or Zapier?

Теңшелетін POS, сервер, сайт немесе толық басқару үшін API пайдаланыңыз. Көрнекі тармақталған сценарийлер үшін Make пайдаланыңыз. Zapier қолданбасын негізінен сызықтық іске қосу әрекеті жұмыс процесі үшін пайдаланыңыз. Үшеуі бірдей API кілтіне және API келісімшартына сүйенеді.

Келесі қадам

Алдымен ең кішкентай сейфті API ағынын тексеріңіз

Кілтті жасаңыз, GET /templates нөміріне қоңырау шалыңыз, бір реттік контактіге бір шақыру жасаңыз, содан кейін дәлелденген сұрау айналасында өндірістік құпияларды, журналды тіркеуді, қайталауды және веб-хукты өңдеуді қосыңыз.