---
title: 外部連携APIの概要
description: 外部アプリがOAuthでトレカクラウドにつなぎ、買取強化対象や在庫を読むためのAPIです。
sidebar:
  label: 概要
---

外部連携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`        |

## 使えること

| 権限（scope）          | 使えること                                 |
| ---------------------- | ------------------------------------------ |
| `purchase-boosts:read` | 買取強化対象の一覧を読む。在庫は見えません |
| `inventory:read`       | 拠点・保管場所・在庫の個体を同期する       |
| `inventory:write`      | 販売した個体を確保して出庫する             |
| `inventory:move`       | 棚の移動、拠点間の移動、持ち出しと戻し     |

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

## はじめるまでの流れ

1. **店舗が連携先を登録する**

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

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

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

3. **接続を作る**

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

4. **APIを呼ぶ**

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

各エンドポイントの詳細は[APIリファレンス](/api/reference)にあります。