APIリファレンスとドキュメントの見方

api reference swagger openapi community
このガイドについて
レシートローラーの開発者向けドキュメントは複数の入り口に分かれています。それぞれの役割と使い分けを把握しておくと、必要な情報に最短で辿り着けます。

APIリファレンスとドキュメントの見方

レシートローラーの開発者向けドキュメントは、目的別に大きく4つの入り口があります。本ヘルプでは概念やユースケースを解説し、エンドポイントの正確な仕様はリファレンスで、不明点はコミュニティで、という使い分けです。


4つの入り口

入り口 用途 こんなときに
開発者ヘルプ(このサイト) 概念・利用開始・ユースケース別ガイド 「何ができるか」「どう設計するか」を理解したい
APIトップページ よく使われるAPIの早見表とサンプル 代表的なエンドポイントをすぐに試したい
APIリファレンス(Swagger) 全エンドポイントの正確な仕様 パラメータ・レスポンス・エラーコードを正確に確認したい
開発者コミュニティ 質問・回答の蓄積、運営チームへの相談 ドキュメントで解決しない疑問・既出のFAQを探したい

1. 開発者ヘルプ(このサイト)

いま読んでいるサイトです。概念の説明・実装方針・ユースケース別の進め方をまとめています。「特定のエンドポイントの仕様」ではなく「全体としてどう作るか」を知るためのものです。


2. APIトップページ

https://receiptroller.io/ja-JP/api/top

レシートローラーAPIのトップページです。よく使われる代表的なエンドポイント(人気のAPI)を、シンプルなサンプル付きで一覧化しています。

  • こう使う — 「とりあえず取引データを取りたい」「ユーザーレシートを取得するエンドポイントってどれ?」のような、最短で着手したいときの入り口
  • 各エンドポイントには必要なスコープサンプルリクエストが表示されます
  • 詳細仕様が必要な場合は、各エンドポイントから次節のリファレンスへ遷移できます

3. APIリファレンス(Swagger / OpenAPI)

https://receiptroller.io/docs/api/reference

全エンドポイントの完全なリファレンスです。OpenAPI(Swagger)仕様で生成されており、パラメータ・リクエスト本体・レスポンス本体・エラーコードまですべて確認できます。

  • こう使う — 「このパラメータは省略可能?」「レスポンスの正確なJSON構造は?」「このエンドポイントはどんなエラーを返す?」を確認するとき
  • カテゴリ別(Store / CRM / SNS / Analytics / User / Survey など)に整理されています
  • 各エンドポイントで必要なスコープがバッジで明示されます
  • 「Try it out」ボタンで、ブラウザから直接リクエストを試せます(要トークン)
  • OpenAPI仕様(JSON / YAML)をダウンロードして、SwaggerやPostmanなどのツールに取り込めます

Swaggerの効率的な使い方

  • 左サイドバーで領域を絞る — Store / CRM / Analyticsなどのタグで該当領域だけを表示
  • キーワード検索 — エンドポイント名・タグ・説明文を横断検索
  • スキーマセクション — レスポンスに含まれるオブジェクト構造を独立して確認
  • サーバー切り替え — 本番・ステージングなどの環境をプルダウンで切り替え可能

4. 開発者コミュニティ

https://receiptroller.io/ja-JP/developers/community

開発者同士・運営チームと質疑応答できるコミュニティです。ドキュメントで解決しない疑問や、他の開発者が同じことで悩んでいないかを確認できます。

  • 質問する前に — キーワード検索で既出の質問を確認してください。同じ疑問が解決済みになっている可能性があります
  • 質問の投稿方法コミュニティに質問を投稿する
  • 回答の受け取り方質問への回答を受け取る
  • 運営チームからの回答には「スタッフ」バッジが付きます
  • 機密情報(クライアントシークレット・アクセストークンなど)は本文に含めないでください

使い分けの例

実際の開発フローでは、これらを組み合わせて使うのが効率的です。

  • 初めて触る → 開発者ヘルプ(このサイト)でユースケースガイドを読む
  • とりあえず動かしたい → APIトップページから人気エンドポイントを選んでサンプルを試す
  • 本格実装に入る → Swaggerリファレンスで正確な仕様を確認しながらコーディング
  • 仕様で迷ったら → コミュニティで既出質問を検索 → なければ投稿
  • 本番リリース前 → 開発者ヘルプの「運用とセキュリティ」を再確認

ドキュメントが古いと感じたら

レシートローラーは継続的に機能を追加しているため、まれにヘルプとリファレンスの間で記述に乖離が出ることがあります。仕様の正は常にAPIリファレンス(Swagger)です。実際のレスポンスがヘルプの記述と異なる場合は、リファレンス側を信用してください。

明らかな誤りや、改善のご提案がありましたらコミュニティまたはサポートまでお知らせください。


関連ガイド

公開日: 2026-04-27 更新日: 2026-04-27
このトピックについて
開発者API
機能の詳細を見る
タグ
API (8) Webhook (8) api (6) oauth (5) トラブル (5) OAuth (4) getting-started (4) アプリ登録 (4) app-registration (3) webhook (3)
関連記事