API リファレンス

レスポンス

200

トークンの持ち主 Me

例

curl -s "$BASE/me" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

200

取引の一覧 DealList

例

curl -s "$BASE/deals" \
  -H "Authorization: Bearer $TOKEN"

本文

JSON(Content-Type: application/json)

レスポンス

201

作った取引 DealLocation 作った取引の API の URL(パス)

400

bad-request リクエストの形が正しくありません

422

invalid 入力を確認してください(fields を見てください)

例

curl -sX POST "$BASE/deals" \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"shopName":"鳥源","slug":"torigen","kind":"food"}'

パラメーター

レスポンス

200

取引の詳細 DealDetail

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

例

curl -s "$BASE/deals/$DEAL_ID" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

本文

JSON(Content-Type: application/json)

レスポンス

200

変えたあとの取引 Deal

400

bad-request リクエストの形が正しくありません

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

422

invalid 入力を確認してください(fields を見てください)

例

curl -sX PATCH "$BASE/deals/$DEAL_ID" \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"shopName":"鳥源","slug":"torigen","kind":"food"}'

パラメーター

レスポンス

200

顧客ページのある取引(customerUrl が入る) Deal

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

no-active-version 先に表示する版を選んでください(activate)wrong-phase いまの状態ではこの操作はできません

例

curl -sX POST "$BASE/deals/$DEAL_ID/issue" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

200

確認を頼んだ版{ reviewVersion: integer }

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

no-active-version 先に表示する版を選んでください(activate)wrong-phase いまの状態ではこの操作はできませんunchanged 修正の依頼のあとは、直した版をアップロードして表示する版に切り替えてから確認依頼を出してください

例

curl -sX POST "$BASE/deals/$DEAL_ID/request-review" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

200

キャンセルした{ phase: "canceled" }

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

wrong-phase いまの状態ではこの操作はできません

例

curl -sX POST "$BASE/deals/$DEAL_ID/cancel" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

200

新しい顧客ページの URL{ customerUrl: string, mailed: boolean }

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

wrong-phase いまの状態ではこの操作はできません

例

curl -sX POST "$BASE/deals/$DEAL_ID/rotate-token" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

200

非公開かどうか{ suspended: boolean }

403

suspend-denied 顧客が公開を承認したサイトは運営だけが非公開にできます。止めたいときは運営にご連絡ください

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

resume-denied このサイトは運営だけが公開に戻せます

例

curl -sX POST "$BASE/deals/$DEAL_ID/suspend" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

200

非公開かどうか{ suspended: boolean }

403

suspend-denied 顧客が公開を承認したサイトは運営だけが非公開にできます。止めたいときは運営にご連絡ください

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

resume-denied このサイトは運営だけが公開に戻せます

例

curl -sX POST "$BASE/deals/$DEAL_ID/resume" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

201

新しい取引{ id: string, siteCopy: "copied" | "nothing" | "failed" }Location 作った取引の API の URL(パス)

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

wrong-phase いまの状態ではこの操作はできません

例

curl -sX POST "$BASE/deals/$DEAL_ID/recontract" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

本文

ファイルそのもの(Content-Type: application/zip)

レスポンス

201

新しい版 Uploaded

400

bad-request リクエストの形が正しくありません

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

wrong-phase いまの状態ではこの操作はできません

413

too-large zip の上限(30MB)を超えています

422

zip zip を受け付けられません。理由は message にあります

例

curl -sX POST "$BASE/deals/$DEAL_ID/versions?name=site.zip" \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/zip' \
  --data-binary @site.zip

パラメーター

本文

JSON(Content-Type: application/json)

レスポンス

200

表示している版{ activeVersion: integer }

400

bad-request リクエストの形が正しくありません

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

bad-version この版は表示できません(アップロードが済んだ版を指定してください)wrong-phase いまの状態ではこの操作はできません

例

curl -sX POST "$BASE/deals/$DEAL_ID/activate" \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"version":2}'

パラメーター

レスポンス

200

回答 Hearing

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

例

curl -s "$BASE/deals/$DEAL_ID/hearing" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

200

回数に数えないことにした依頼の通し番号{ round: integer }

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

wrong-phase いまの状態ではこの操作はできませんalready-uncounted この修正の依頼はもう回数に数えないことにしています

例

curl -sX POST "$BASE/deals/$DEAL_ID/revisions/{responseId}/uncount" \
  -H "Authorization: Bearer $TOKEN"

パラメーター

レスポンス

200

写真(image/*)

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

例

curl -s "$BASE/deals/$DEAL_ID/files/$FILE_ID" \
  -H "Authorization: Bearer $TOKEN" \
  -o photo.jpg

パラメーター

レスポンス

200

済にした作業{ done: "gbp" }

404

not-found 見つかりません(ほかの人の取引にも同じように返します)

409

wrong-phase いまの状態ではこの操作はできません

例

curl -sX POST "$BASE/deals/$DEAL_ID/followup/gbp" \
  -H "Authorization: Bearer $TOKEN"