開発ガイドライン

はじめに

レシートローラーの支払いデータ補完サービスは、 APIを介して支払いデータを補完するサービスです。 支払いに対して購入した先の店舗・ブランド・商品情報などを取得することができます。

1. 購入者にこれらのデータを提供することで、購入者は自身の購入履歴をより詳しく把握することができます。
2. 購入先詳細情報を知ることで、チャージバックを削減することができるため、利用店舗に売上向上に寄与します。
3. 支払い履歴を見た際に詳細が表示されていることにより、カード会社への問合せが減少し、カード会社の運営コスト削減につながります。
4. 購入先の店舗ごとにラベリングされているため、購入者は自身の購入履歴から自動的に利用区分を把握することができます。

利用前に必要なもの

レシートローラービジネスアカウントが必要となります。レシートローラービジネスサイトよりアカウントを作成してください。

環境設定

APIを利用するには特別なソフトウェアや環境は必要ありません。HTTPリクエストを送信することができる環境であれば利用可能です。 Swaggerドキュメントを利用することで、APIのエンドポイントやパラメター、レスポンスを確認することができます。

APIアクセストークンの取得方法

レシートローラーAPIではベアラートークンを採用しています。 ベアラートークン認証は、APIリクエストの認証にトークンを使用する方法です。このトークンは、 APIへのリクエストを送る際に、このトークンをHTTPヘッダーに含めて提供することで、 自分が認証されたユーザーであることを証明します。

トークンの取得: 最初に、ログインや特定の認証手続きを通じてAPIサーバーからベアラートークンを取得します。このプロセスは通常、ユーザー名とパスワードや他の認証情報を提供することで行われます。

トークンの使用: トークンを取得したら、APIリクエストを行う際に、HTTPヘッダーにAuthorizationフィールドを追加し、Bearer {トークン}の形式でトークンを含めます。ここで、{トークン}はあなたが取得した実際のトークンに置き換えてください。

環境ごとのエンドポイント

本番環境と開発環境のエンドポイントは以下の通りです。

共通パラメター

返り値がリストの場合、ページネーションを行うためのパラメターは共通で下記の通りです。

例:

パラメター	説明
currentPage	現在のページ番号
itemsPerPage	1ページの表示件数
totalItems	検索結果の総件数
totalPages	検索結果の総ページ数
keyword	検索キーワード
sort	表示順を指定する文字列
items	対象オブジェクトの配列

エラーコード

エラーが発生した場合、エラーコードとエラーメッセージが返却されます。

エラーコードは以下の通りです。

エラーコード	説明
200 OK	リクエストが成功し、レスポンスと共にデータが返されます。
201 Created	リクエストが成功し、新しいリソースが作成されました。
204 No Content	リクエストが成功したが、コンテンツは返されません。
400 Bad Request	サーバーがリクエストを理解できない。不正なリクエスト形式など。
401 Unauthorized	認証が必要なリクエストで認証情報が提供されていない、または認証に失敗した。
403 Forbidden	サーバーがリクエストを理解したが、アクセス権を拒否します。
404 Not Found	リクエストされたリソースが見つかりません。
405 Method Not Allowed	許可されていないHTTPメソッドが使用されました。
429 Too Many Requests	レート制限を超えたリクエストが行われました。
500 Internal Server Error	サーバー側で未処理のエラーが発生しました。
501 Not Implemented	サーバーがリクエストされた機能を実装していない。
503 Service Unavailable	サービスが一時的に利用不可です。
1001 Invalid Parameter	リクエストに無効なパラメータが含まれています。
1002 Authentication Failure	認証情報が無効または期限切れです。
1003 Resource Quota Exceeded	リソースの割り当て量を超えました。
1004 Unsupported API Version	サポートされていないAPIバージョンが指定されました。

制限事項

リクエストレート制限

• 本APIへのリクエストは、1分間に最大120回までとします。この制限を超えるリクエストは受け付けられません。
• 窓口制御（レートの動的調整）は基本的に行いませんが、システムの安定性を保つため、必要に応じて実施する場合があります。

データ取得制限

• 一度に取得できるデータは、1ページあたり最大100件までです。これは、入れ子となっているデータについても同様です。

データ更新制限

• データの更新は、1分間に最大20回までとします。この頻度を超える更新操作は許可されません。

サービス可用性

• 当APIは基本的に24時間365日稼働を目指しています。ただし、システムのメンテナンスや改善のため、計画的なダウンタイムが定期的に発生します。ダウンタイムについては、事前に通知いたします。

利用地域とサポート

• 本APIは、日本国内での利用を想定しており、サポート範囲も日本での利用に限定されます。
• サポートサービスのレベルは、ご利用のプランに準じます。詳細なサポート内容については、各プランの説明をご参照ください。

法的制約と規制遵守

• 本APIの利用者は、日本国内の法律および規制を遵守することが求められます。また、APIを通じて取得したデータの利用にあたっても、適用される法令を遵守してください。

バージョン

現在ご利用いただけるAPIのバージョンは、v1です。

FAQ