api webhook overview getting-started

このガイドについて
レシートローラーの開発者ポータルで提供している連携手段（REST API・Webhook）と、それぞれを使ってできることを概観します。これから実装を始める方向けの最初のページです。

開発者ポータルでできること

レシートローラーの開発者ポータルでは、購買・売上・商品・在庫・広告・ユーザーレシートなどのリテールデータを、外部システムから安全に連携するための手段を提供しています。連携手段はREST APIとWebhookの2つです。

2つの連携手段

外部システムからレシートローラーのサーバーへ HTTPS リクエストを送信し、データを取得・操作します。OAuth 2.0 で認証し、必要なスコープのアクセストークンを使ってエンドポイントを呼び出します。

レシートローラー側で発生したイベント（レシート発行・更新など）を、登録した URL へ自動的に POST します。外部システムが定期的にAPIをポーリングする必要がなく、イベントが発生した瞬間に処理を起動できます。

OAuth スコープによってアクセスできるリソースが分かれています。以下は代表的な例です。スコープの完全な一覧はOAuthスコープ一覧をご覧ください。

カテゴリ	主な操作	代表的なスコープ
商品・在庫	商品マスター・SKU・在庫数の参照と更新	`store.products.*` `store.inventory.read`
受注	受注データの参照、ステータス更新	`store.orders.*`
顧客・CRM	顧客データ・セグメントの参照	`store.customers.read` `crm.profiles.read`
クーポン	クーポンの作成・更新・参照	`store.coupons.*`
店舗チラシ	チラシの作成・公開	`store.flyers.*`
SNS・分析	SNS投稿・オーディエンス・分析データの参照	`sns.*` `analytics.read`
ユーザー（要審査）	個人ユーザーのレシート・支出・お気に入り店舗	`user.*`

レシートローラー上のイベントを購読して、外部システムでリアルタイムに処理できます。

署名検証・リトライ・冪等性の設計など、実装上の注意点は店舗向けWebhookガイドをご覧ください。

やりたいこと	使う手段	関連ガイド
自社の店舗で会計が完了したら、自社サーバーへレシートデータを送りたい	Webhook + Store系API	店舗向けガイド
自社のウォレットアプリで、ユーザーが受け取った全店舗のレシートを表示したい	OAuth + User系API（要審査）	ウォレットアプリ向けガイド
外部の在庫管理システムから商品マスター・在庫を同期したい	Store系API（バッチ）	—
店舗のSNS投稿パフォーマンスを社内BIツールで可視化したい	SNS / Analytics系API	—
店頭アンケートの回答をデジタルレシートに埋め込んで集計したい	Survey API + Receipt embed	Survey APIガイド（英語）

各言語向けの公式SDKは現在開発中です。提供開始までは、各言語の標準的なHTTPクライアントとOAuth 2.0ライブラリを組み合わせて実装してください。