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

7stamp REST API

Наличен

7stamp Integration API позволява CRM, платформа за електронна търговия, POS, персонализирана бекенд или инструмент за автоматизация управлявайте карти за лоялност на портфейла с идентификатора за контакт, който вашата собствена система вече използва. Това е универсалният вариант, когато не съществува специализирана интеграция.

Базата API URL е https://api.7loc.com/cards-api. Удостоверете всяка заявка с ключ API като токен Bearer. Използвайте свързаната справка OpenAPI за схемите на живи заявки и отговори, преди да изградите производствена логика.

Какво можете да правите с API

API е страната за запис на интеграционния стек. Използвайте го винаги, когато вашият собствен софтуер трябва да остане оперативният източник на истина, докато 7stamp управлява слоя за лоялност на портфейла.

Издайте карти от вашия собствен софтуер

Генерирайте линк за лична портфейлна карта за всеки клиент във вашата система. Доставете го чрез собствения си имейл, SMS, push или поток в приложението. Клиентът отваря връзката и запазва картата на 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

Вземете шаблонен дизайн

Чете визуално настройки за известен шаблон на карта.

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

Издаване на ваучер

Издава ваучер на собственик на карта.

Съобщения POST /messages/send

Изпратете съобщение

Изпраща push-картата на портфейла и/or имейл съдържание до собственик на карта.

Къде да създадете и копирате ключа API

Това са реални екрани 7stamp Admin. Отворете API & Integrations, добавете ключ, след което го копирайте в защитена тайна връзка от страната на сървъра или автоматизирана връзка. Екран

7stamp Admin API & Integrations, показващ бутона Add API Key и диалоговия прозорец Generate API Key
Стъпка 1 — Изберете API & Integrations в лявата навигация, отворете 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, за да избегнете сблъсъци между системите и да направите ясна корелацията на webhook.

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

Когато профилът има един активен шаблон, 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

Влезте в 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?

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

Трябва ли да използвам API, Make или Zapier?

Използвайте API за персонализиран POS, бекенд, сайт или пълен контрол. Използвайте Make за сценарии за визуално разклоняване. Използвайте Zapier за предимно линеен работен процес за задействане. И трите разчитат на един и същ ключ API и договор API.

Следваща стъпка

Тествайте първо най-малкия сейф API поток

Създайте ключа, обадете се на GET /templates, създайте една покана за контакт за еднократна употреба, след това добавете производствени тайни, регистриране, повторни опити и обработка на webhook около доказаната заявка.