通い放題プラン・回数券API の使い方
レシートローラーの通い放題プランAPI(/api/v1/reservations/memberships)と回数券API(/api/v1/reservations/passes)のガイドです。プランと回数券商品の管理、ご加入者・ご購入者の一覧、解約、他システムからの回数券の取り込みまでを解説します。
プランがフリーのまま開発者ポータルが表示されない
レシートローラーの開発者ポータルが表示されない場合の確認手順。プランがフリーの場合の対処方法、ビジネスアカウント切り替え、表示反映タイミングを解説します。
はじめてのAPI呼び出し:アプリ登録から取引一覧の取得まで
OAuth認可コードフロー(PKCE)でトークンを取得し、ビジネスアカウントを確認して取引一覧を取得、トークンを更新するまでを通して行います。
トークンが取得できない(認証エラー)
トークンエンドポイントが400/401を返すときの切り分け方。invalid_client、invalid_grant などのエラーと error_description ごとの対処を解説します。
アプリを新規作成する
ビジネスアカウントに開発者アプリを登録する手順を、入力項目、クレデンシャルの表示、作成後にできること、よくあるつまずきまで説明します。
Webhookで新しい売上を受け取り、Slackに通知する
receipt.created Webhookを登録し、Node.jsで署名検証と重複除去をしてSlackに売上を投稿するまでを手順で説明します。
API認証ガイド
OAuth 2.0 認可コードフローでの認証方法を、認可URLのパラメーター、同意画面、トークン交換・取り消し、エラー、スコープまで解説します。
アクセストークンの取得と更新
アクセストークン(8時間)とリフレッシュトークン(30日)の取得・更新の手順、更新ごとの入れ替わり、使えなくなるケースを説明します。
SLA・稼働率と障害時の確認手順
レシートローラーAPIの稼働率目標、ステータスページの確認方法、障害発生時の切り分け手順、サポートエスカレーションの流れを解説します。
403/401が返る(権限・スコープ)
API呼び出しで401や403が返るときの原因切り分け。トークン無効・スコープ不足・店舗アクセス権なし・User系審査未通過などの典型ケースを解説します。
店舗の予約を自社のカレンダーに表示する
予約管理APIで店舗の7日分の予約を取得し、Node.jsでiCalendar(.ics)ファイルに書き出してカレンダーに表示する手順です。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
レート制限とスロットリング
レシートローラーAPIでリクエスト数の制限があるエンドポイントと上限、429の返り方、クライアント側の流量の抑え方とリトライ方針を説明します。
エラーコードとリトライ指針
レシートローラーAPIのエラー時のステータスコードと本文の形、トークンエンドポイントのエラー、送り直してよいケースと方法を説明します。
商品マスタを自社システムと同期する
手元のCSV・JSONを読み、SKUで照合して商品を作成・差分更新するNode.jsスクリプトを、商品APIで作ります。
Webhookの概要
実際に送信されるWebhookイベント、届くリクエストの形と署名ヘッダー、重複・順序・取りこぼしの扱い、APIとの使い分けを説明します。
Webhookの登録方法
開発者ポータルの画面とAPIでWebhookを登録する手順、購読イベントの選び方、テスト送信、変更・一時停止・削除の方法を説明します。
商品管理API(Products API)の使い方
商品API(/api/v1/products)の一覧・取得・作成・PATCHとPUTによる更新・論理削除・画像アップロードを、項目名と注意点つきで説明します。
予約管理API(Reservations API)の使い方
予約管理APIで予約の取得・作成・変更・時間変更、予約枠の生成、メニューの空き時刻、予約設定、席、月次件数を扱う方法です。