EmDashの記事を、別のサイトやアプリでも使う
管理画面と表示先を分ける構成で、取得する内容・認証・公開状態・更新反映を設計します。
目次
EmDashで書いたお知らせは、別の企業サイトやスマートフォンアプリへ届ける構成を作れます。そのためには、内容を取得し、表示先に合う形で見せる処理の開発が必要です。
このように、内容を管理する場所と、読者へ表示する場所を分けて使うCMSを、ヘッドレスCMSと呼びます。このガイドは、外部連携を作る開発担当者と、配信する内容を決める担当者向けです。
たとえば、原稿はEmDashだけで編集し、会社サイトと会員アプリへ同じお知らせを出す使い方です。編集担当者は「何を、どこへ、いつ反映したいか」を決め、開発担当者が表示先に合わせてデータを届ける処理を作ります。
コピーして管理する前に、読み取りだけで足りるか考える
同じお知らせを複数の管理画面へ登録すると、修正のたびに差を埋める作業が増えます。元の原稿をEmDashへ集め、別の表示先は必要な情報を読む構成なら、編集場所をまとめられます。
最初に、外へ渡す項目を決めます。
| 内容 | 配信する例 |
|---|---|
| 記事 | 公開済みのタイトル、本文、公開URL |
| 画像 | 表示用URL、代替テキスト、必要なサイズ情報 |
| 分類 | 読者向けのカテゴリ名 |
| 管理用情報 | 内部メモなどは配信対象から外す |
取得できる項目を全部渡すのではなく、表示先に必要な項目を選びます。
管理用APIを、無認証の公開APIだと思わない
EmDashのREST APIは、通常/_emdash/api/以下にあります。APIは、プログラム同士が内容を受け渡す窓口です。内容の取得にも、認証された接続が必要です。
トークンは、接続するプログラムの認証に使う秘密の文字列です。管理者のトークンをブラウザー内のJavaScriptや配布するアプリへ埋め込むと、利用者へその認証情報を渡すことになります。一般読者向けの配信では、サーバー側で必要な内容を読み、公開してよい項目だけ返す構成を検討します。
たとえば「EmDash → 配信する内容を選ぶサーバー → 会社サイト・会員アプリ」という流れを作ります。中央のサーバーが認証情報を持ち、公開してよいタイトルと本文だけを返します。この中央の処理も開発担当者が用意します。
「読み取り専用のトークン」も、「どの情報を読めるか」は別に確認が必要です。役割と権限、下書きへのアクセスを調べます。
連携の入口と、形式を確認する
まず開発担当者が、接続先のAPI仕様書を確認します。そのサイトの管理画面に管理者としてログインし、同じブラウザーでサイトURLの末尾に /_emdash/api/openapi.json を付けて開きます。OpenAPIは、使える操作、入力する値、返ってくる情報を記す仕様書の形式です。仕様書で必要な操作を探すと、その操作に何を渡せばよいか確認できます。
受け取ったデータの形を見たいときは、練習サイトで記事一覧と1件の詳細を取得する例を動かしてみてください。
ソースコードに通信先が見つかっても、外部向けに保証されたAPIとは限りません。公式のREST APIガイド(別タブで開く)では、OpenAPIに含まれる範囲を確認するよう案内しています。
最初は、確認用のお知らせ1件を読むところから始めます。タイトルと本文が取れたら、一覧を複数ページに分けて取得する方法を確認します。最初のページだけで止まらず、最後のページまで取得できるかを確かめてください。
本文と画像には、表示側の準備も必要
本文がPortable Text形式なら、見出し・段落・画像などに分かれたデータを、表示先の画面へ変換する処理が必要です。文章の文字列や完成したHTMLを表示する方法とは異なります。
画像URLが、表示先から開ける住所になっているかも確認します。管理画面へログインしているときだけ見える画像URLを、そのまま一般読者へ渡していないかを見ます。
公開状態と言語を、表示先でも守る
公開済みの内容だけを配る条件を決め、下書きや予約前の内容が混じらないことを確認します。公開中の記事を下書きで修正している場合も、読者へ渡すのは公開版です。「記事の状態が公開済み」と「取得した本文が公開版」は、両方確かめます。多言語の場合は言語も指定し、翻訳同士のIDとURLを混同しないようにします。
外部サイト側でコピーを保存するなら、公開を取り消した内容や削除した内容を、いつ消すかも必要です。「新しい記事を追加できた」だけでは同期の確認は終わりません。
小さな試験で、更新の一周を確かめる
確認用の記事1本で、次の順に表示先を開き直します。修正の反映に何分かかるかも、制作担当者と決めておきます。
| EmDash側で行うこと | 別サイト・アプリで期待する結果 |
|---|---|
| 下書きを保存する | まだ一般読者には表示されない |
| 公開する | タイトル・本文・画像が表示される |
| 公開後、下書きだけを直す | 公開中の内容が維持される |
| 修正を公開する | 決めた時間内に新しい内容へ変わる |
| 公開を取り消す | 決めた時間内に読者向け表示から外れる |
通信に失敗した場合に、古い内容を出すか、案内を出すかも決めます。
ブラウザーから別ドメインへ直接通信する場合は、CORSの設定も確認します。CORSは、別のサイトから送られたリクエストの応答を、ブラウザー内のプログラムが読めるかを決める仕組みです。誰がどの情報を読んでよいかという認証や公開範囲の設定は、別に必要です。
使わない情報を、ブラウザーへ渡さない
サーバーで取得したデータの全項目を、そのままHTMLやJavaScriptへ埋め込まないようにします。表示していない下書きや社内用メモも、通信内容から読める場合があります。
公開する項目を選んで返し、未ログインのリクエストで結果を確認します。RSS・サイトマップ・関連記事・検索用のデータも、それぞれ公開状態と言語を守っているかを試します。未公開情報の経路点検と同じテストデータで照合できます。