---
seo:
  description: >-
    店舗が許可した外部アプリのためのAPIです。OAuth 2.1 の認可コードフロー（PKCE
    S256）で受け取ったアクセストークンを、Authorization: Bearer…
sidebar:
  label: Overview
title: トレカクラウド 外部連携API
---
店舗が許可した外部アプリのためのAPIです。OAuth 2.1 の認可コードフロー（PKCE S256）で受け取ったアクセストークンを、`Authorization: Bearer` で付けて呼びます。どの店舗の情報を扱うかはトークンで決まります。

すべての応答に `Cache-Control: no-store` が付きます。エラーは `{ "error": "コード" }` の形です。

Version 1

Base URL: `https://api.toreca-cloud.com/partner/v1`

## 接続

店舗との接続を作る・確かめる・やめる操作です。どちらかの読み取り権限で呼べます。

- [`GET /connection`](/api/reference/接続/get-connection) — 接続を確かめる.
- [`POST /connection`](/api/reference/接続/create-connection) — 接続を作る.
- [`DELETE /connection`](/api/reference/接続/delete-connection) — 接続をやめる.

## 買取強化対象

店舗が通常より高く買い取るカードやBOXの一覧です。`purchase-boosts:read` で読めます。

- [`GET /purchase-boosts`](/api/reference/買取強化対象/list-purchase-boosts) — 買取強化対象の一覧を取得する.

## 在庫

拠点・保管場所・在庫の個体の同期です。`inventory:read` が必要です。

- [`GET /inventory/sites`](/api/reference/在庫/list-sites) — 拠点と保管場所を取得する.
- [`GET /inventory/changes`](/api/reference/在庫/list-changes) — 在庫の変更を読む.
- [`GET /inventory/items/{id}/photos/{side}`](/api/reference/在庫/get-item-photo) — 個体の写真を取得する.

## カードマスタ

トレカクラウドのカードマスタの検索です。`inventory:read` が必要です。

- [`GET /cards`](/api/reference/カードマスタ/search-cards) — カードマスタを検索する.
- [`GET /cards/{id}`](/api/reference/カードマスタ/get-card) — カードを1件取得する.

## 変更通知

在庫が変わったことを知らせるWebhookの登録です。`inventory:read` が必要です。

- [`PUT /webhook`](/api/reference/変更通知/set-webhook) — Webhookを登録する.
- [`DELETE /webhook`](/api/reference/変更通知/delete-webhook) — Webhookを消す.