予約管理API(Reservations API)の使い方
レシートローラーの予約管理API(/api/v1/reservations)のガイドです。予約のCRUD・ステータス更新、予約枠(スロット)の取得・作成・一括生成、店舗レイアウトに登録された席(テーブル・個室・カウンター)の取得、予約統計までを解説します。
帳票・請求関連データ(対応範囲)
レシートローラーが扱う帳票・請求関連データの対応範囲、税率レポート、インボイス制度対応、会計ソフト連携の指針を解説します。
SLA・稼働率と障害時の確認手順
レシートローラーAPIの稼働率目標、ステータスページの確認方法、障害発生時の切り分け手順、サポートエスカレーションの流れを解説します。
SNS Webhookバイパス(LINEなど外部SNSのWebhook転送)
レシートローラーがLINE等のSNSプラットフォームから受け取ったWebhookを、店舗側の同意のもとで開発者アプリへ転送する「SNS Webhookバイパス」機能の仕組み、設定方法、署名の取り扱い、注意点を解説します。
リダイレクトURLの設定
レシートローラーの開発者ポータルで設定するリダイレクトURI(コールバックURL)の役割、登録ルール、開発・本番環境の使い分け、よくあるエラーと対処方法を解説します。
クライアントID・クライアントシークレットの管理
レシートローラーのアプリ登録時に発行されるクライアントID・クライアントシークレットの取得方法、保管ルール、漏えい時の対応、複数環境での運用を解説します。
再送・順序・冪等性の設計
レシートローラーWebhookの再送ポリシー、配信順序が保証されない理由、event_idを使った冪等性の実装、デッドレターの扱い、よくあるアンチパターンを解説します。
リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
PosTransactionDto 仕様 — 取引データのフィールドリファレンス
レシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
従業員管理API(Staff API)の使い方
レシートローラーの従業員管理API(/api/v1/staff)でビジネスアカウント配下の従業員(スタッフ)をCRUD操作するためのガイドです。Square Team Member 互換のフィールド(カナ名、複数業務割当、給与構造)に対応しています。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
商品管理API(Products API)の使い方
レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。
アクセストークンの取得と更新
レシートローラーAPIで使うアクセストークンとリフレッシュトークンの取得方法、有効期限、更新手順、エラー時の対処を解説します。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
アクセス制御と監査ログ
レシートローラー連携アプリ運用におけるアクセス制御の設計、最小権限、監査ログの取り方、定期レビューの実施方法を解説します。
OAuthスコープ一覧と利用可否
レシートローラーのOAuth APIで利用できるスコープの一覧と、各スコープがどの種類のアプリに付与されるかを説明します。User系スコープの審査要件、Store系とUser系を混在できない理由、LIFFアプリからの利用方法もカバーします。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
Webhookの登録方法
レシートローラーの開発者ポータルでWebhookエンドポイントを登録する手順、購読イベントの選び方、テスト配信、複数エンドポイントの使い分け、削除と一時停止の方法を解説します。