コンテンツにスキップ
commentor API
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

文書を上げる

HTML の文書を上げ、本文を差し替え、版を追加する手順。

取り込み用トークンで、HTML の文書を commentor に上げます。例では、トークンを環境変数 CR_IMPORT_TOKEN に入れています。

export ORIGIN=https://comment-review.fsmarketing.workers.dev

新しく上げる

HTML のファイルをマルチパートのフォームで送ります。

curl -i -X POST "$ORIGIN/api/reviews/import-html" \
  -H "Authorization: Bearer $CR_IMPORT_TOKEN" \
  -F "html=@page.html;type=text/html" \
  -F "title=料金ページの下書き" \
  -F "accessMode=restricted"
  • 成功すると 303 が返り、Location ヘッダーが /reviews/<文書の ID> を指します。この ID を以降の操作に使います。ブラウザで開く URL は $ORIGIN/reviews/<文書の ID> です。
  • accessMode は、link(リンクを知る人が見られる。省略時)か restricted(招待した人だけ)です。
  • 画像は HTML の中に埋め込んでください。HTML は 25 MiB までです。

本文を差し替える

文書の URL とコメントはそのままに、本文だけを新しくします。

curl -X POST "$ORIGIN/api/reviews/review_example01/import-html" \
  -H "Authorization: Bearer $CR_IMPORT_TOKEN" \
  -F "html=@page.html;type=text/html"

差し替えられるのは、取り込み用トークンで作った文書だけです。

版を追加する

前の版とそのコメントを残したまま、新しい版を足します。画面では版を切り替えて見比べられます。

  1. 文書を読み、最新の版の ID を控えます。応答の review.source.versions の最後の要素の versionId です。

    curl "$ORIGIN/api/reviews/review_example01" -H "Authorization: Bearer $CR_IMPORT_TOKEN"
  2. mode=add-version で送ります。versionId は足す版の ID で、自分で決めます。expectedVersionId には 1 で控えた ID を入れます。

    curl -X POST "$ORIGIN/api/reviews/review_example01/import-html" \
      -H "Authorization: Bearer $CR_IMPORT_TOKEN" \
      -F "html=@page-v2.html;type=text/html" \
      -F "mode=add-version" \
      -F "versionId=v2" \
      -F "expectedVersionId=v1" \
      -F "label=第 2 稿"
  • 同じ versionId と同じ本文を送り直しても、版は 2 つにならず、同じ結果が返ります。通信が切れたときはそのまま送り直せます。
  • 409 stale_expected_version は、控えた版の後に別の版が足されたことを示します。応答の latestVersionId で読み直して送り直してください。

項目の詳細は 文書を上げる と 本文を差し替える・版を追加する を見てください。

このページは役に立ちましたか?