利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
開発者ポータルでできること
レシートローラーの開発者ポータルでできることを概観します。REST APIによるデータ取得・操作、Webhookによるリアルタイムイベント受信を組み合わせて、外部システムから店舗・ユーザーデータを連携できます。
APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。開発者ヘルプ・APIトップページ・SwaggerベースのAPIリファレンス・開発者コミュニティの4つの入り口と、AIアシスタントやコード生成ツールで使えるOpenAPI仕様(openapi/v1.json)の取得方法を案内します。
アプリケーション登録とは
レシートローラーのアプリケーション登録の概念を説明します。OAuthクライアントとしてアプリを登録することで、クライアントID・シークレット・リダイレクトURIが発行され、API・Webhook連携を始められます。
User系スコープでapp_not_approvedが返る
User系スコープを使うとapp_not_approvedエラーが返る場合の確認手順。サンドボックス枠での開発、審査申請、サンドボックス本番化の流れを解説します。
ネイティブモバイルアプリ向けガイド: 複数ビジネスアカウントアクセスと OAuth フロー
Android / iOS のネイティブアプリ向け実装ガイド。アプリ登録時に「認可時に1つのビジネスアカウントへトークンを紐付ける」をオフにすると、user-scoped OAuth トークンが発行されます。/api/v1/me/organizations + ?organizationId= パターンで複数ビジネスアカウントを横断アクセスできます。
403/401が返る(権限・スコープ)
API呼び出しで401や403が返るときの原因切り分け。トークン無効・スコープ不足・店舗アクセス権なし・User系審査未通過などの典型ケースを解説します。
アプリを新規作成する
レシートローラーの開発者ポータルで新しいアプリ(OAuthクライアント)を登録する具体的な手順を説明します。入力項目・バリデーション・作成後のクレデンシャル表示・よくあるエラーまでをカバーします。
予約管理API(Reservations API)の使い方
レシートローラーの予約管理API(/api/v1/reservations)のガイドです。予約のCRUD・ステータス更新、予約枠(スロット)の取得・作成・一括生成、店舗レイアウトに登録された席(テーブル・個室・カウンター)の取得、予約統計までを解説します。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
帳票・請求関連データ(対応範囲)
レシートローラーが扱う帳票・請求関連データの対応範囲、税率レポート、インボイス制度対応、会計ソフト連携の指針を解説します。
取引一覧API(Transactions API:POS+OMS統合フィード)の使い方
レシートローラーのTransactions APIは、レジ売上(PosTransactions)と販売管理注文(OmsOrders)を1つのフィードに統合した読み取り専用APIです。Android/iOSアプリで「ビジネスアカウント全体の取引」を一覧表示する際の入り口になります。
ビジネスアカウント・店舗・POS端末の一覧を取得する
レシートローラーのモバイルアプリ/サーバーアプリから、ユーザーが所属するビジネスアカウント、その配下の店舗、各店舗のPOS端末をREST APIで一覧する手順をまとめます。
利用目的・接続先(POS/EC/分析など)の申告
レシートローラーの開発者ポータルでアプリを登録する際に申告する「利用目的」と「接続先カテゴリ」(POS/EC/分析/CRM/OMS/WMS/SNS/その他)の意味、選び方、変更時の注意、User系スコープ審査との関連を解説します。
営業時間API(Business Hours API)の使い方
レシートローラーの営業時間API(/api/v1/stores/{storeId}/business-hours)のガイドです。曜日ごとの営業時間の取得・更新、特例営業日(臨時休業・営業時間変更)の登録、店舗の就業可能時間(シフト作成時の上限となる業務時間)の設定、現在営業中かどうかの判定までを解説します。
商品管理API(Products API)の使い方
レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。
リダイレクトURLの設定
レシートローラーの開発者ポータルで設定するリダイレクトURI(コールバックURL)の役割、登録ルール、開発・本番環境の使い分け、よくあるエラーと対処方法を解説します。
代表的なAPI例
レシートローラーAPIの代表的なエンドポイントの呼び出し例(レシート取得・店舗一覧・商品作成・Webhook登録)をcurlコマンドで紹介します。
購買・レシートデータ連携
レシートローラーが扱う購買・レシートデータの構造、取得方法、関連スコープ、Webhook、よくあるユースケースを解説します。