リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。開発者ヘルプ・APIトップページ・SwaggerベースのAPIリファレンス・開発者コミュニティの4つの入り口と、AIアシスタントやコード生成ツールで使えるOpenAPI仕様(openapi/v1.json)の取得方法を案内します。
Webhookの概要
レシートローラーのWebhookで配信される主要なイベント種別、ポーリングではなくWebhookを使うべき理由、配信形式(HTTPS POST + JSON)、配信保証の考え方を解説します。
代表的なAPI例
レシートローラーAPIの代表的なエンドポイントの呼び出し例(レシート取得・店舗一覧・商品作成・Webhook登録)をcurlコマンドで紹介します。
PosTransactionDto 仕様 — 取引データのフィールドリファレンス
レシートローラーが扱う取引データの正規モデル PosTransactionDto の全フィールドを解説します。識別子・日時・金額・明細・支払い・スタッフ・ステータス・CRM 連携の各カテゴリーごとに、フィールド名・型・意味・各 POS ベンダーからの埋め方をまとめた、開発者および外部システム連携担当者向けのリファレンスです。スマレジ・Square 双方のマッピング記事からも参照されます。
トークンが取得できない(認証エラー)
アクセストークンが取得できないときの原因切り分け。invalid_client、invalid_grant、redirect_uri_mismatch などの代表的エラーと対処を解説します。
予約管理API(Reservations API)の使い方
レシートローラーの予約管理API(/api/v1/reservations)のガイドです。予約のCRUD・ステータス更新、予約枠(スロット)の取得・作成・一括生成、店舗レイアウトに登録された席(テーブル・個室・カウンター)の取得、予約統計までを解説します。
営業時間API(Business Hours API)の使い方
レシートローラーの営業時間API(/api/v1/stores/{storeId}/business-hours)のガイドです。曜日ごとの営業時間の取得・更新、特例営業日(臨時休業・営業時間変更)の登録、店舗の就業可能時間(シフト作成時の上限となる業務時間)の設定、現在営業中かどうかの判定までを解説します。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
商品管理API(Products API)の使い方
レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。
署名検証とセキュリティ
レシートローラーWebhookのHMAC-SHA256署名検証の仕組み、検証コードのサンプル(Node.js / Python / C#)、リプレイ攻撃対策、シークレットの安全な管理方法を解説します。
SNS Webhookバイパス(LINEなど外部SNSのWebhook転送)
レシートローラーがLINE等のSNSプラットフォームから受け取ったWebhookを、店舗側の同意のもとで開発者アプリへ転送する「SNS Webhookバイパス」機能の仕組み、設定方法、署名の取り扱い、注意点を解説します。
ProductDto リファレンス
レシートローラーの商品マスタ(PIM)である ProductDto の全フィールドを解説します。POS(Square)からの商品カタログ同期、原価・店舗別価格・バリエーション・プレオーダーなどの構造をまとめています。
従業員管理API(Staff API)の使い方
レシートローラーの従業員管理API(/api/v1/staff)でビジネスアカウント配下の従業員(スタッフ)をCRUD操作するためのガイドです。Square Team Member 互換のフィールド(カナ名、複数業務割当、給与構造)に対応しています。
店舗内メディアディスプレイAPI(Display API)の使い方
レシートローラーの店舗内 Android ディスプレイ向け API(/api/v1/displays/*)の概要とペアリング・ハートビート・プレイリスト取得・再生実績報告の手順をまとめます。Android キオスクや店舗サイネージ端末でメディアループを再生するアプリを実装するための入門ガイドです。
販売管理API(Orders / OMS API)の使い方
レシートローラーの販売管理API(/api/v1/orders)でビジネスアカウント配下の受注をCRUD操作するためのガイドです。注文の作成・更新・状態遷移(確認・処理中・キャンセル)・削除と、Android/iOSアプリやサーバー連携向けのフローをまとめます。
商品マスター(PIM)・カテゴリデータ
レシートローラーの商品マスター(PIM)・カテゴリ・バリエーションのデータ構造、CRUD操作、SKU管理、ECとの同期パターンを解説します。
店舗向け:自社アプリでデジタルレシートを発行・Webhookで通知するガイド
店舗・ブランドが自社アプリでデジタルレシートをお客様に発行し、Webhookでリアルタイム通知を受け取るまでの手順を解説します。アプリ登録・OAuth・Webhook設定・署名検証をカバーします。
エンドポイントとバージョニング
レシートローラーAPIのベースURL、バージョニング方針、廃止予告の流れ、現行バージョンの確認方法を解説します。