Интеграција програмера

7stamp REST API

Доступан

7stamp Integration API омогућава платформи CRM, платформи за е-трговину, POS, прилагођеној позадини или алатки за аутоматизацију да управља картицама лојалности новчаника са идентификатором контакта који ваш систем већ користи. То је универзална опција када не постоји специјализована интеграција.

База API URL је https://api.7loc.com/cards-api. Аутентификујте сваки захтев помоћу кључа API као токена Bearer. Користите повезану референцу OpenAPI за шеме захтева и одговора уживо пре него што изградите производну логику.

Шта можете да урадите са API

API је страна за писање интеграционог стека. Користите га кад год ваш софтвер треба да остане оперативни извор истине док 7stamp управља слојем лојалности новчаника.

Издајте картице из сопственог софтвера

Генеришите везу личне картице новчаника за било ког клијента у вашем систему. Испоручите га путем сопствене е-поште, SMS, пусх-а или тока у апликацији. Купац отвара везу и чува картицу на Apple Wallet или Google Wallet.

Кредитне марке из било ког извора

Када се куповина затвори у вашем прилагођеном POS, када се онлајн поруџбина плати на вашој веб страници или када се услуга заврши у вашем систему за резервације, позовите API да бисте кредитирали маркице. Картица се ажурира у року од неколико секунди.

Управљајте ваучерима и кампањама

Издајте једнократни ваучер одређеном купцу, креирајте токове награда спремних за кампању и вратите статус ваучера у системе који управљају финансијама и квалитетом услуга.

Документоване операције интеграције API

Ово су јавне руте API иза акција Make и Zapier. Прочитајте тачну шему у референци 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

Набавите дизајн шаблона

Прочитајте визуелне шаблоне99⟦999999⟟ подешавања за познати шаблон картице.

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

Издајте ваучер

Издаје ваучер власнику картице.

Поруке POST /messages/send

Пошаљи поруку

Шаље садржај картице новчаника и/or е-поште власнику картице.

Где креирати и копирати кључ API

Ово су прави екрани 7stamp Admin. Отворите API & Интегратионс, додајте кључ, а затим га копирајте у безбедну тајну или аутоматизовану везу на страни сервера.

7stamp Admin API & Интегратионс екран који приказује дугме Add API Key и Генерирај API дијалог тастера лево
Корак 1 — Изаберите 613⟧ у навигацији. API Keys, изаберите Add API Key, изаберите одговарајућу пријаву особља и генеришите кључ.
7stamp Admin дијалог који приказује новогенерисани кључ API и његову контролу копирања
Корак 2 — Копирајте нови кључ у менаџер лозинки, тајну на страни сервера или безбедну везу ⟦29617⟦296. Немојте га лепити у изворни код, апликацију претраживача или карту за подршку.

Три одлуке које треба донети пре кодирања

API опсег кључа

Креирајте кључ у 7stamp Admin под API Integrations → API KeysAdd API Key. Кључ припада једном радном месту/profile, па креирајте одвојене кључеве за развој и производњу када вам подешавања налога то дозвољавају. Ротирајте или опозовите приступ са контролне табле ако је тајна откривена.

Идентитет клијента

External ID је стабилан идентификатор контакта из вашег система: а CRM ID, купац UUID, број телефона или. Дајте предност непроменљивом систему ID. Опционо додајте External Source да бисте избегли колизије између система и да би корелација веб-хука била експлицитна.

Избор шаблона

Када профил има један активан шаблон, template_id се може изоставити и 7stamp га аутоматски бира. Када има више активних шаблона, проследите предвиђени template_id. Прво прочитајте GET /templates уместо да чврсто кодирате нагађани ID.

Минимални захтев за проверу аутентичности: креирајте позивницу

Копирајте ово у свој корак аутоматизације 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

Sign in to 7stamp Admin and create a key: API Integrations → API KeysAdd API Key. Store it in your secret manager, not source code or a client-side application.

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. Прочитајте га пре имплементације руковања грешкама или додавања опционих поља.

Аутентификација и безбедност кључа

Кључ је тајна на страни сервера. Немојте га излагати у ЈаваСцрипт-у претраживача, пакету мобилних апликација, јавном обрасцу, снимцима екрана, 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_КЕИ на сваки овлашћени захтев.

Када могу да изоставим template_id?

Само када повезани профил има тачно један активни шаблон картице. Ако је активно више шаблона, изаберите исправан template_id од GET /templates.

Да ли да користим API, Make или Zapier?

Користите API за прилагођени POS, позадину, локацију или потпуну контролу. Користите Make за сценарије визуелног гранања. Користите Zapier за углавном линеарни радни ток окидача. Сва три се ослањају на исти API кључ и API уговор.

Следећи корак

Прво тестирајте најмањи сигуран проток API

Креирајте кључ, позовите GET /templates, креирајте једну позивницу за контакт за једнократну употребу, а затим додајте тајне производње, евидентирање, поновне покушаје и руковање веб-хуком око доказаног захтева.