Tích hợp dành cho nhà phát triển

7stamp REST API

Có sẵn

7stamp Integration API cho phép CRM, nền tảng thương mại điện tử, POS, chương trình phụ trợ tùy chỉnh hoặc công cụ tự động hóa quản lý ví thẻ khách hàng thân thiết có mã nhận dạng liên hệ mà hệ thống của bạn đã sử dụng. Đây là tùy chọn phổ biến khi không có sự tích hợp chuyên biệt.

Cơ sở API URL là https://api.7loc.com/cards-api. Xác thực mọi yêu cầu bằng khóa API làm mã thông báo Bearer. Sử dụng tham chiếu OpenAPI được liên kết cho các lược đồ phản hồi và yêu cầu trực tiếp trước khi xây dựng logic sản xuất.

Bạn có thể làm gì với API

API là mặt ghi của ngăn xếp tích hợp. Sử dụng nó bất cứ khi nào phần mềm của riêng bạn phải là nguồn hoạt động đáng tin cậy trong khi 7stamp xử lý lớp khách hàng thân thiết của ví.

Phát hành thẻ từ phần mềm của riêng bạn

Tạo liên kết thẻ ví cá nhân cho bất kỳ khách hàng nào trong hệ thống của bạn. Gửi nó qua email của riêng bạn, SMS, đẩy hoặc luồng trong ứng dụng. Khách hàng mở link và lưu thẻ vào Apple Wallet hoặc Google Wallet.

Tem tín dụng từ bất kỳ nguồn nào

Khi giao dịch mua hàng kết thúc theo tùy chỉnh của bạn POS, khi đơn đặt hàng trực tuyến được thanh toán trên trang web của bạn hoặc khi một dịch vụ được hoàn thành trong hệ thống đặt chỗ của bạn, hãy gọi API để nhận tem tín dụng. Thẻ cập nhật trong vòng vài giây.

Quản lý phiếu thưởng và chiến dịch

Cấp phiếu thưởng một lần cho một khách hàng cụ thể, tạo luồng phần thưởng sẵn sàng cho chiến dịch và đưa trạng thái phiếu thưởng trở lại hệ thống xử lý chất lượng dịch vụ và tài chính.

Tích hợp tài liệu API hoạt động

Đây là các tuyến đường công khai API đằng sau hành động Make và Zapier. Đọc lược đồ chính xác trong tài liệu tham khảo API; không suy ra tên trường từ một điểm cuối khác.

Thẻ POST /cards/invite

Tạo lời mời thẻ

Tạo cài đặt cá nhân mới URL cho một liên hệ bên ngoài.

Thẻ POST /cards/invite/bulk

Tạo hàng loạt lời mời thẻ

Tạo tối đa 100 liên kết mời trong một đợt được kiểm soát.

Thẻ GET /cards

Tìm thẻ

Tra cứu hồ sơ thẻ theo mã định danh liên hệ bên ngoài.

Thẻ GET /cards/{user_card_id}

Nhận chi tiết thẻ

Trả về trạng thái đầy đủ của một thẻ bằng nội bộ 7stamp ID của nó.

Thẻ POST /cards/scan

Quét thẻ

Thêm tem theo thẻ ID hoặc External ID và ghi lại thứ tự nguồn khi được cung cấp.

Mẫu GET /templates

Danh sách mẫu

Liệt kê các mẫu thẻ có sẵn tại nơi làm việc của chìa khóa/profile.

Mẫu GET /templates/{template_id}/design

Nhận thiết kế mẫu

Đọc cài đặt trực quan cho một thẻ đã biết mẫu.

Voucher POST /vouchers/issue

Phát hành voucher

Cấp voucher cho chủ thẻ.

Tin nhắn POST /messages/send

Gửi tin nhắn

Gửi nội dung email đẩy thẻ ví và/or cho chủ sở hữu thẻ.

Nơi tạo và sao chép khóa API

Đây là những màn hình 7stamp Admin thực. Mở API & Tích hợp, thêm khóa rồi sao chép khóa đó vào kết nối tự động hóa hoặc bí mật phía máy chủ an toàn.

7stamp Admin API & Màn hình Tích hợp hiển thị nút Add API Key và Tạo API Hộp thoại chính
Bước 1 — Chọn API & Tích hợp trong điều hướng bên trái, mở API Keys, chọn Add API Key, chọn thông tin đăng nhập nhân viên thích hợp và tạo khóa. Hộp thoại
7stamp Admin hiển thị khóa API mới được tạo và điều khiển sao chép của nó
Bước 2 — Sao chép khóa mới vào trình quản lý mật khẩu, bí mật phía máy chủ hoặc kết nối Make/Zapier bảo mật. Không dán nó vào mã nguồn, ứng dụng trình duyệt hoặc phiếu hỗ trợ.

Ba quyết định cần đưa ra trước khi mã hóa

API phạm vi khóa

Tạo khóa trong 7stamp Admin trong API Integrations → API KeysAdd API Key. Khóa thuộc về một nơi làm việc/profile, vì vậy hãy tạo các khóa riêng biệt để phát triển và sản xuất khi thiết lập tài khoản của bạn cho phép. Xoay vòng hoặc thu hồi quyền truy cập từ trang tổng quan nếu bí mật bị lộ.

Danh tính khách hàng

External ID là mã định danh liên hệ ổn định từ hệ thống của bạn: a CRM ID, khách hàng UUID, số điện thoại hoặc email. Thích một hệ thống bất biến ID. Tùy ý thêm External Source để tránh xung đột giữa các hệ thống và làm cho mối tương quan giữa webhook trở nên rõ ràng.

Lựa chọn mẫu

Khi hồ sơ có một mẫu đang hoạt động, template_id có thể được bỏ qua và 7stamp sẽ tự động chọn mẫu đó. Khi nó có nhiều mẫu đang hoạt động, hãy chuyển template_id dự định. Trước tiên hãy đọc GET /templates thay vì mã hóa cứng một ID.

Yêu cầu được xác thực tối thiểu: tạo lời mời

Sao chép phần này vào bước tự động hóa của bạn 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
  }'

Từ khóa API cho đến yêu cầu thành công đầu tiên

01

Đăng nhập vào 7stamp Admin và tạo khóa: API Integrations → API KeysAdd API Key. Lưu trữ nó trong trình quản lý bí mật của bạn chứ không phải mã nguồn hoặc ứng dụng phía máy khách.

02

Đặt cơ sở URL thành https://api.7loc.com/cards-api và thêm Authorization: Bearer theo sau là khóa cho mọi yêu cầu phía máy chủ.

03

Trước tiên hãy gọi GET /templates. Phản hồi thành công sẽ xác nhận mã thông báo và hiển thị các mẫu có sẵn cho nơi làm việc đó/profile.

04

Chọn External ID ổn định và External Source tùy chọn từ hệ thống của riêng bạn. Sử dụng cùng một cặp danh tính trong logic tạo, quét, tra cứu và webhook.

05

Gọi POST /cards/invite bằng liên hệ thử nghiệm dùng một lần. Xác minh cài đặt được trả lại URL trước khi tự động phân phối cho khách hàng thực.

06

Chỉ thêm các hành động POST /cards/scan, chứng từ hoặc tin nhắn sau khi bạn đã ghi nhật ký, xử lý lỗi và chiến lược thử lại/idempotency an toàn trong phần phụ trợ của riêng bạn.

Sử dụng tham chiếu API làm hợp đồng

Tham chiếu công khai Swagger/OpenAPI chứa các lược đồ điểm cuối, tham số, nội dung yêu cầu, phản hồi và webhook hiện tại. Tương tác URL là https://api.7loc.com/cards-api/docs và hợp đồng mà máy có thể đọc được là https://api.7loc.com/cards-api/openapi.json. Hãy đọc nó trước khi triển khai xử lý lỗi hoặc thêm các trường tùy chọn.

Xác thực và an toàn khóa

Khóa là bí mật phía máy chủ. Không hiển thị nó trong JavaScript của trình duyệt, gói ứng dụng dành cho thiết bị di động, biểu mẫu công khai, ảnh chụp màn hình, trường văn bản Make/Zapier hoặc phiếu hỗ trợ. Sử dụng máy chủ, kết nối tự động hóa an toàn hoặc trình quản lý bí mật. Nếu khóa vô tình được chia sẻ, hãy thu hồi hoặc xoay khóa đó trong 7stamp Admin và cập nhật kết nối bị ảnh hưởng.

Câu hỏi thường gặp

Tôi lấy mã thông báo 7stamp API ở đâu?

Trong 7stamp Admin, đi tới API Integrations → API Keys → Add API Key. Sau đó, mã thông báo sẽ được gửi trong tiêu đề Authorization dưới dạng Bearer theo sau là khóa.

Cơ sở URL và phương thức xác thực là gì?

Sử dụng https://api.7loc.com/cards-api và gửi Authorization: Bearer YOUR_7STAMP_API_KEY trên mỗi yêu cầu được ủy quyền.

Khi nào tôi có thể bỏ qua template_id?

Chỉ khi hồ sơ được kết nối có đúng một mẫu thẻ đang hoạt động. Nếu nhiều mẫu đang hoạt động, hãy chọn template_id đúng từ GET /templates.

Tôi có nên sử dụng API, Make hay Zapier không?

Sử dụng API cho POS tùy chỉnh, phụ trợ, trang web hoặc toàn quyền kiểm soát. Sử dụng Make cho các kịch bản phân nhánh trực quan. Sử dụng Zapier cho quy trình làm việc kích hoạt hành động chủ yếu là tuyến tính. Cả ba đều dựa trên cùng một khóa API và hợp đồng API.

Bước tiếp theo

Kiểm tra mức an toàn nhỏ nhất API luồng trước

Tạo khóa, gọi GET /templates, tạo một lời mời cho một liên hệ dùng một lần, sau đó thêm bí mật sản xuất, ghi nhật ký, thử lại và xử lý webhook xung quanh yêu cầu đã được chứng minh.