写真をURLにロゴ

APIドキュメント

API は有効な Pro または Premium 契約が必要です。APIキーで認証すると、ダッシュボードと同じライブラリに画像をアップロードできます。枠はウェブサイトの有料プランと同じです。

商品画像

画像をアップロード

POST /api/v1/upload(multipart/form-data)。

パラメータ

Authorization
必須。リクエストヘッダー。形式:Bearer あなたのAPIキー。
file
必須。バイナリファイル、または base64 データ。
name
任意。ファイル名。ローカルファイルを multipart で送ると自動検出されます。

リクエスト例

バイナリファイル

curl https://phototourl.com/api/v1/upload \
  -X POST \
  -H "Authorization: Bearer ptu_live_YOUR_KEY" \
  -F "file=@./product.jpg"

Base64

curl https://phototourl.com/api/v1/upload \
  -X POST \
  -H "Authorization: Bearer ptu_live_YOUR_KEY" \
  -F "file=R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" \
  -F "name=pixel.gif"

ローカルファイルのアップロードは必ず POST を使ってください。GET でのアップロードは非対応です。

レスポンスフィールド

id
ライブラリ内のリソース id。
url
商品ページで使える CDN URL。
fileName
元のファイル名。
fileSize
ファイルサイズ(バイト)。
mimeType
アップロードしたファイルの MIME タイプ。
createdAt
UTC のアップロード時刻。形式は YYYY-MM-DD HH:mm:ss。
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "url": "https://cdn.phototourl.com/pro/2026-11-05-a1b2c3d4-e5f6-7890-abcd-ef1234567890.jpg",
  "fileName": "product.jpg",
  "fileSize": 128472,
  "mimeType": "image/jpeg",
  "createdAt": "2026-11-05 10:20:30"
}

画像一覧

GET /api/v1/images。任意で page と pageSize(最大 100)。

curl "https://phototourl.com/api/v1/images?page=1&pageSize=20" \
  -H "Authorization: Bearer ptu_live_YOUR_KEY"

レスポンスフィールド

resources
画像配列:id、fileName、url、fileSize、mimeType、createdAt。
page
現在のページ番号。
pageSize
1ページあたりの件数。
total
ライブラリ内の画像総数。
{
  "resources": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "fileName": "product.jpg",
      "url": "https://cdn.phototourl.com/pro/2026-11-05-a1b2c3d4-e5f6-7890-abcd-ef1234567890.jpg",
      "fileSize": 128472,
      "mimeType": "image/jpeg",
      "createdAt": "2026-11-05 10:20:30"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 1
}

画像を削除

DELETE /api/v1/images/:id。ストレージとライブラリからファイルを削除します。

curl -X DELETE https://phototourl.com/api/v1/images/RESOURCE_ID \
  -H "Authorization: Bearer ptu_live_YOUR_KEY"

レスポンスフィールド

success
削除成功時は true。
{ "success": true }

上限

無料プランでは API は使えません。Pro / Premium はプランのアップロード・容量・ファイルサイズ上限に従います。超えると upgradeUrl 付きのエラーが返ることがあります。

エラー

失敗時はエラーコードを返します。枠超過では upgradeUrl が含まれることがあります。

  • dailyLimitReached— 1日のアップロード上限に達しました(HTTP 429)。
  • storageLimitReached— ストレージ枠を超過しました(HTTP 413)。
  • fileTooLarge— プランで許可されるサイズを超えています(HTTP 400)。
  • 401— APIキーが未指定、無効、または取り消し済みです。
{
  "error": "dailyLimitReached",
  "errorParams": { "limit": 1000 },
  "plan": "paid",
  "limit": 1000,
  "upgradeUrl": "https://www.phototourl.com/pricing"
}