Інтеграція розробника

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