はじめてのAPI呼び出し:アプリ登録から取引一覧の取得まで
OAuth認可コードフロー(PKCE)でトークンを取得し、ビジネスアカウントを確認して取引一覧を取得、トークンを更新するまでを通して行います。
PosTransactionDto 仕様 — 取引データのフィールドリファレンス
レシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
取引一覧API(Transactions API:POS+OMS統合フィード)の使い方
レシートローラーのTransactions APIは、レジ売上(PosTransactions)と販売管理注文(OmsOrders)を1つのフィードに統合した読み取り専用APIです。Android/iOSアプリで「ビジネスアカウント全体の取引」を一覧表示する際の入り口になります。
購買・レシートデータ連携
レシートローラーが扱う購買・レシートデータの構造、取得方法、関連スコープ、Webhook、よくあるユースケースを解説します。
Webhookで新しい売上を受け取り、Slackに通知する
receipt.created Webhookを登録し、Node.jsで署名検証と重複除去をしてSlackに売上を投稿するまでを手順で説明します。
Webhookの概要
実際に送信されるWebhookイベント、届くリクエストの形と署名ヘッダー、重複・順序・取りこぼしの扱い、APIとの使い分けを説明します。
再送・順序・冪等性の設計
Webhookの成功条件と再送の規則(1分・10分・1時間、最大4回)、順序と取りこぼし、X-RR-Deliveryで重複を除く受信側の作り方を説明します。
エラーコードとリトライ指針
レシートローラーAPIのエラー時のステータスコードと本文の形、トークンエンドポイントのエラー、送り直してよいケースと方法を説明します。
店舗の予約を自社のカレンダーに表示する
予約管理APIで店舗の7日分の予約を取得し、Node.jsでiCalendar(.ics)ファイルに書き出してカレンダーに表示する手順です。
商品マスタを自社システムと同期する
手元のCSV・JSONを読み、SKUで照合して商品を作成・差分更新するNode.jsスクリプトを、商品APIで作ります。
Webhookが届かない
Webhookが届かないときに、テスト送信と配信ログで原因を切り分け、無効化・購読イベント・接続・署名検証を順に確認する手順です。
監視と失敗時の対応
Webhookの有効状態・最終送信日時・配信ログの見方と、自動で無効になったことに気づいて復旧し、抜けた期間をAPIで補う方法を説明します。
MCPでAIエージェントをレシートローラーに接続する
ClaudeをMCPコネクタとして接続する手順と、動的クライアント登録・PKCE・JSON-RPCで自作のMCPクライアントから呼び出す方法を解説します。
OAuthスコープ一覧と利用可否
レシートローラーのOAuth APIで利用できるスコープの一覧と、各スコープがどの種類のアプリに付与されるかを説明します。User系スコープの審査要件、Store系とUser系を混在できない理由、LIFFアプリからの利用方法もカバーします。
アプリを新規作成する
ビジネスアカウントに開発者アプリを登録する手順を、入力項目、クレデンシャルの表示、作成後にできること、よくあるつまずきまで説明します。
予約管理API(Reservations API)の使い方
予約管理APIで予約の取得・作成・変更・時間変更、予約枠の生成、メニューの空き時刻、予約設定、席、月次件数を扱う方法です。
商品管理API(Products API)の使い方
商品API(/api/v1/products)の一覧・取得・作成・PATCHとPUTによる更新・論理削除・画像アップロードを、項目名と注意点つきで説明します。