外部連携APIの概要

外部アプリがOAuthでトレカクラウドにつなぎ、買取強化対象や在庫を読むためのAPIです。

外部連携API（パートナーAPI）は、店舗が許可した外部アプリのためのAPIです。LPやXの投稿に買取強化対象を載せるアプリ、在庫を同期するオリパや業務システムがこのAPIを使います。

外部アプリは、店舗のメンバーがブラウザで許可したときに発行されるトークンでAPIを呼びます。APIキーの共有はしません。どの店舗の情報を読むかはトークンで決まり、リクエストで店舗を指定することはできません。

基本情報

項目	値
ベースURL	`https://api.toreca-cloud.com/partner/v1`
認可	OAuth 2.1 の認可コードフロー（PKCE S256 が必須）
クライアント	事前登録した機密クライアント（`client_secret_basic`）
形式	JSON。すべての応答に `Cache-Control: no-store`

LPや投稿用のアプリには purchase-boosts:read だけを許可してください。在庫を一切見せずに、買取強化対象だけを渡せます。

店舗が連携先を登録する

店舗の管理者が、設定の「外部連携」で連携先を登録します。表示名、戻り先URL、許可することを選ぶと、クライアントIDとクライアントシークレットが発行されます。外部連携の画面が見えないときは、トレカクラウドの運営にご連絡ください。

店舗のメンバーが接続を許可する

外部アプリが認可画面を開き、店舗のメンバーがログインして「許可する」を押します。外部アプリは認可コードをトークンに交換します（認可の流れ）。

接続を作る

最初に POST /connection を呼びます。店舗が接続を解除すると、以後のAPIは connection_revoked で拒否されます。

APIを呼ぶ

アクセストークンをBearerで付けて呼びます。トークンの保管と更新はトークンの保管と有効期限を守ってください。

各エンドポイントの詳細はAPIリファレンスにあります。