リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
MCPでAIエージェントをレシートローラーに接続する
ClaudeをMCPコネクタとして接続する手順と、動的クライアント登録・PKCE・JSON-RPCで自作のMCPクライアントから呼び出す方法を解説します。
商品マスタを自社システムと同期する
手元のCSV・JSONを読み、SKUで照合して商品を作成・差分更新するNode.jsスクリプトを、商品APIで作ります。
トークンが取得できない(認証エラー)
トークンエンドポイントが400/401を返すときの切り分け方。invalid_client、invalid_grant などのエラーと error_description ごとの対処を解説します。
PosTransactionDto 仕様 — 取引データのフィールドリファレンス
レシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
商品管理API(Products API)の使い方
商品API(/api/v1/products)の一覧・取得・作成・PATCHとPUTによる更新・論理削除・画像アップロードを、項目名と注意点つきで説明します。
Webhookで新しい売上を受け取り、Slackに通知する
receipt.created Webhookを登録し、Node.jsで署名検証と重複除去をしてSlackに売上を投稿するまでを手順で説明します。
はじめてのAPI呼び出し:アプリ登録から取引一覧の取得まで
OAuth認可コードフロー(PKCE)でトークンを取得し、ビジネスアカウントを確認して取引一覧を取得、トークンを更新するまでを通して行います。
予約管理API(Reservations API)の使い方
予約管理APIで予約の取得・作成・変更・時間変更、予約枠の生成、メニューの空き時刻、予約設定、席、月次件数を扱う方法です。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
API認証ガイド
OAuth 2.0 認可コードフローでの認証方法を、認可URLのパラメーター、同意画面、トークン交換・取り消し、エラー、スコープまで解説します。
署名検証とセキュリティ
X-RR-Signatureの計算方法とNode.js・Python・C#の検証コード、リプレイへの備え、Webhookシークレットの入れ替え方を説明します。
Webhookの登録方法
開発者ポータルの画面とAPIでWebhookを登録する手順、購読イベントの選び方、テスト送信、変更・一時停止・削除の方法を説明します。
エンドポイントとバージョニング
レシートローラーAPIのベースURL、バージョニング方針、廃止予告の流れ、現行バージョンの確認方法を解説します。
Webhookの概要
実際に送信されるWebhookイベント、届くリクエストの形と署名ヘッダー、重複・順序・取りこぼしの扱い、APIとの使い分けを説明します。
エラーコードとリトライ指針
レシートローラーAPIのエラー時のステータスコードと本文の形、トークンエンドポイントのエラー、送り直してよいケースと方法を説明します。
アクセストークンの取得と更新
アクセストークン(8時間)とリフレッシュトークン(30日)の取得・更新の手順、更新ごとの入れ替わり、使えなくなるケースを説明します。
Webhookが届かない
Webhookが届かないときに、テスト送信と配信ログで原因を切り分け、無効化・購読イベント・接続・署名検証を順に確認する手順です。
商品マスター(PIM)・カテゴリデータ
レシートローラーの商品マスター(PIM)・カテゴリ・バリエーションのデータ構造、CRUD操作、SKU管理、ECとの同期パターンを解説します。
APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。開発者ヘルプ・APIトップページ・SwaggerベースのAPIリファレンス・開発者コミュニティの4つの入り口と、AIアシスタントやコード生成ツールで使えるOpenAPI仕様(openapi/v1.json)の取得方法を案内します。