Интеграция с разработчиками

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 и «Интеграции», добавьте ключ, затем скопируйте его в безопасное секретное соединение на стороне сервера или в автоматическое соединение.

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. Сначала прочитайте 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. Успешный ответ подтверждает токен и показывает шаблоны, доступные для этого рабочего места: 7639⟧

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, создайте одно приглашение для одноразового контакта, затем добавьте производственные секреты, ведение журнала, повторные попытки и обработку веб-перехватчиков для подтвержденного запроса.