代表的なAPI例
レシートローラーAPIの代表的なエンドポイントの呼び出し例(レシート取得・店舗一覧・商品作成・Webhook登録)をcurlコマンドで紹介します。
商品マスター(PIM)・カテゴリデータ
レシートローラーの商品マスター(PIM)・カテゴリ・バリエーションのデータ構造、CRUD操作、SKU管理、ECとの同期パターンを解説します。
PosTransactionDto 仕様 — 取引データのフィールドリファレンス
レシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
CrmCustomerDto リファレンス
レシートローラーの顧客マスタである CrmCustomerDto の全フィールドを解説します。POS(スマレジ・Square)から取り込まれた顧客情報がこのモデルに正規化されます。
再送・順序・冪等性の設計
レシートローラーWebhookの再送ポリシー、配信順序が保証されない理由、event_idを使った冪等性の実装、デッドレターの扱い、よくあるアンチパターンを解説します。
StaffDto リファレンス
レシートローラーのスタッフ(従業員)マスタである StaffDto の全フィールドを解説します。POS(Square Team / スマレジ)との関連付け、店舗アサイン、雇用形態などの構造をまとめています。
Webhookの概要
レシートローラーのWebhookで配信される主要なイベント種別、ポーリングではなくWebhookを使うべき理由、配信形式(HTTPS POST + JSON)、配信保証の考え方を解説します。
APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。開発者ヘルプ・APIトップページ・SwaggerベースのAPIリファレンス・開発者コミュニティの4つの入り口と、AIアシスタントやコード生成ツールで使えるOpenAPI仕様(openapi/v1.json)の取得方法を案内します。
ProductDto リファレンス
レシートローラーの商品マスタ(PIM)である ProductDto の全フィールドを解説します。POS(Square)からの商品カタログ同期、原価・店舗別価格・バリエーション・プレオーダーなどの構造をまとめています。
データ保護(匿名化・暗号化)の考え方
レシートローラー連携アプリでのデータ保護の考え方、暗号化(保管時・通信時)、匿名化・仮名化のテクニック、削除ポリシーを解説します。
アクセス制御と監査ログ
レシートローラー連携アプリ運用におけるアクセス制御の設計、最小権限、監査ログの取り方、定期レビューの実施方法を解説します。
帳票・請求関連データ(対応範囲)
レシートローラーが扱う帳票・請求関連データの対応範囲、税率レポート、インボイス制度対応、会計ソフト連携の指針を解説します。
リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
本番運用のベストプラクティス
レシートローラー連携アプリを本番運用するためのベストプラクティス(環境分離、監視、デプロイ、障害対応、ドキュメント整備)を解説します。
在庫データ連携
レシートローラーの在庫データの構造、複数倉庫管理、入出庫履歴、Webhookによるリアルタイム同期、WMS連携パターンを解説します。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
署名検証とセキュリティ
レシートローラーWebhookのHMAC-SHA256署名検証の仕組み、検証コードのサンプル(Node.js / Python / C#)、リプレイ攻撃対策、シークレットの安全な管理方法を解説します。
店舗向け:自社アプリでデジタルレシートを発行・Webhookで通知するガイド
店舗・ブランドが自社アプリでデジタルレシートをお客様に発行し、Webhookでリアルタイム通知を受け取るまでの手順を解説します。アプリ登録・OAuth・Webhook設定・署名検証をカバーします。