開発者の統合

7stamp REST API

利用可能

7stamp Integration API を使用すると、CRM、e コマース プラットフォーム、POS、カスタム バックエンド、または自動化ツールで、独自のシステムですでに連絡先 ID を使用してウォレット ロイヤルティ カードを管理できます。を使用します。これは、特殊な統合が存在しない場合の汎用オプションです。

API ベース URL は https://api.7loc.com/cards-api. API キーを Bearer トークンとして使用してすべてのリクエストを認証します。本番ロジックを構築する前に、リンクされた OpenAPI リファレンスを使用して、ライブ リクエストとレスポンスのスキーマを確認してください。

オープン API リファレンス オープン OpenAPI JSON

API

API は、統合スタック。 7stamp がウォレット ロイヤルティ レイヤーを処理する一方で、独自のソフトウェアが信頼できる運用ソースであり続ける必要がある場合は、これを使用してください。

独自のソフトウェアからカードを発行します

システム内の顧客の個人ウォレット カード リンクを生成します。自分のメール、SMS、プッシュ、またはアプリ内フローを通じて配信します。顧客はリンクを開いて、カードを Apple Wallet または Google Wallet に保存します。

任意のソースからのクレジット スタンプ

カスタム POS で購入が完了したとき、Web サイトでオンライン注文の支払いが完了したとき、または予約システムでサービスが完了したとき、API に電話してクレジット スタンプを受け取ります。カードは数秒以内に更新されます。

バウチャーとキャンペーンの管理

特定の顧客に 1 回限りのバウチャーを発行し、キャンペーン対応の報酬フローを作成し、財務とサービス品質を処理するシステムにバウチャーのステータスを戻します。

文書化された統合 API オペレーション

これらは、背後にあるパブリック API ルートですMake および Zapier アクション。正確なスキーマについては、API リファレンスを参照してください。別のエンドポイントからフィールド名を推測しないでください。

カード POST /cards/invite

カード招待を作成します

外部連絡先用に新しい個人インストール URL を作成します。

カード POST /cards/invite/bulk

カード招待の一括作成

制御されたバッチで最大 100 個の招待リンクを作成します。

カード GET /cards

カードの検索

外部連絡先 ID によってカード記録を検索します。

カード GET /cards/{user_card_id}

カード詳細の取得

内部 7stamp ID によって 1 枚のカードの完全な状態を返します。

カード POST /cards/scan

カードをスキャンします

カード ID または External ID によってスタンプを追加し、提供されたときにソースの順序を記録します。

テンプレート GET /templates

テンプレートのリスト

キーの職場で利用できるカードテンプレートのリスト/profile.

テンプレート GET /templates/{template_id}/design

テンプレートデザインの取得

キーのビジュアル設定を読み取ります既知のカード テンプレート。

バウチャー POST /vouchers/issue

バウチャーを発行します

カード所有者にバウチャーを発行します。

メッセージ POST /messages/send

メッセージを送信する

ウォレットカードのプッシュと/or 電子メールの内容をカード所有者に送信します。

API キーを作成してコピーする場所

これらは実際の 7stamp Admin 画面です。 API & Integrations を開いてキーを追加し、それを安全なサーバー側シークレットまたはオートメーション接続にコピーします。

7stamp Admin API & Integrations 画面に Add API Key ボタンと Generate API Key ダイアログ
Step 1 — Select API & Integrations in the left navigation, open API Keys, choose Add API Key, select the appropriate staff login, and generate the key.
を示す
Step 2 — Copy the new key into a password manager, server-side secret, or secure Make/Zapier connection. Do not paste it into source code, a browser application, or a support ticket.

コーディング前に行うべき 3 つの決定

API キーのスコープ

API Integrations → API Keys → Add API Key の下の 7stamp Admin にキーを作成します。キーは 1 つのワークプレイス/profile に属するため、アカウント設定で許可されている場合は、開発用と運用用に別のキーを作成します。シークレットが公開された場合は、ダッシュボードからのアクセスをローテーションまたは取り消します。

顧客 ID

External ID は、システムからの安定した連絡先 ID です: CRM ID、顧客 UUID、電話番号、または電子メール。不変システム ID を好みます。オプションで External Source を追加して、システム間の衝突を回避し、Webhook の相関を明示的にします。

テンプレートの選択

プロファイルにアクティブなテンプレートが 1 つある場合、template_id は省略でき、7stamp がそれを自動的に選択します。複数のアクティブなテンプレートがある場合は、目的の template_id を渡します。推測された ID をハードコーディングするのではなく、最初に GET /templates を読んでください。

最小限の認証済みリクエスト: 招待を作成します

これを自動化ステップにコピーします 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 Keys → Add API Key を作成します。ソース コードやクライアント側アプリケーションではなく、シークレット マネージャーに保存します。

02

ベース URL を https://api.7loc.com/cards-api に設定し、Authorization: Bearer の後にキーをすべてのサーバー側リクエストに追加します。

03

まずはGET /templates に電話してください。応答が成功するとトークンが確認され、そのワークプレイスで使用可能なテンプレート/profile.

04

が表示されます。独自のシステムから安定した External ID とオプションの External Source を選択します。作成、スキャン、ルックアップ、および Webhook ロジックでまったく同じ ID ペアを使用します。

05

使い捨てテストコンタクトを使用して、POST /cards/invite に電話します。実際の顧客への配信を自動化する前に、返されたインストール URL を確認してください。

06

POST /cards/scan、バウチャー、またはメッセージアクションは、独自のバックエンドでロギング、エラー処理、および安全な再試行/idempotency 戦略を確立した後にのみ追加してください。

API 参照を契約として使用します

パブリック Swagger/OpenAPI リファレンスには、現在のエンドポイント、パラメーター、リクエスト本文、応答、および Webhook スキーマが含まれています。インタラクティブな 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 を省略できるのはどのような場合ですか?

接続されたプロファイルにアクティブなカード テンプレートが 1 つだけある場合のみ。複数のテンプレートがアクティブな場合は、GET /templates.

Should I use the API, Make, or Zapier?

カスタム POS、バックエンド、サイト、またはフル コントロールには、API を使用します。視覚的な分岐シナリオには Make を使用します。ほとんど直線的なトリガーアクションのワークフローには、Zapier を使用します。 3 つすべてが同じ API キーと API コントラクトに依存します。

関連ページ

オープン API リファレンス オープン OpenAPI JSON Webhook ガイド Make HTTP ガイド

次のステップ

最小の金庫 API の流れを最初にテストします

キーを作成し、GET /templates に電話し、使い捨ての連絡先への招待を 1 つ作成してから、本番環境のシークレット、ロギング、再試行、および実証済みのリクエストに関する Webhook 処理を追加します。

オープン API リファレンス オープン 7stamp Admin