GET Article API 解説

母子保健情報APIのもっとも簡単な活用方法です。
母子健康手帳副読本に掲載されている記事、「妊娠と出産編28本」「育っていく赤ちゃん編29本」をリダイレクト方式で提供します。

概要

S3に置いた読み物のHTMLファイルをコンテンツIDで指定し、リダイレクトさせるAPI。
リクエエストされた認証トークンを用いて認証を行い、認証に成功した場合は、リクエストされたコンテンツIDと紐づくHTMLファイルの署名付きURLを取得して、レスポンスコード「301」として返し、そのURLにリダイレクトさせる。
認証に失敗した場合はレスポンスコード「401」としてレスポンスを返す。

エンドポイント

https://scgsctxwkk.execute-api.ap-northeast-1.amazonaws.com/GETArticle?authenticationId={authenticationId}&authenticationPass={authenticationPass}&tenantId=contents&contentId={contentId}

メソッド

GET

接続先

S3

リクエストデータ

JSON Key必須値の説明
contentIdString必要なコンテンツのファイル名(拡張子を除く)
tenantIdStringcontents(固定)
authenticationIdStringテナント用の認証ID
authenticationPassStringテナント用の認証Password

レスポンスヘッダー

フィールド名
Location対象URL

処理結果ステータス

ステータスメッセージ
302Redirection
401Unauthorized
500INTERNAL SERVER ERROR

サンプルコード

記事のリダイレクト先を取得する例

    
    <?php 
    
      //エンドポイントのURL
      $uri_rest = "https://scgsctxwkk.execute-api.ap-northeast-1.amazonaws.com/GETArticle"; //GET Article API
    
      //テナント用の認証IDを変数に入れる
      $authenticationId = "********************************"; //API導入時に発行します
    
      //テナント用の認証Passwordを変数に入れる
      $authenticationPass = "********************************"; //API導入時に発行します
    
      //contents(固定)
      $tenantId = "contents";
    
      //必要なコンテンツのファイル名(拡張子を除く)
      $contentId = "0-1"; //記事リストはAPI導入時にご案内いたします
    
      //URL組み立て
      $url = sprintf("%s%s%s%s%s%s%s%s%s", $uri_rest, "?authenticationId=", $authenticationId, "&authenticationPass=", $authenticationPass, "&tenantId=", $tenantId, "&contentId=", $contentId);
    
      //リダイレクトURL取得
      $headers = get_headers($url, 1);
      $rurl = $headers['Location'];
    
    ?>
    
  

認証ID、認証Pass、記事ファイル名をつなげURLをGETリクエストして、レスポンスヘッダーよりリダイレクト先のURLを取得します。

ホームページの任意の箇所へIFrameを挿入

    
    <iframe
      width="600"
      height="800"
      src="<?php require('get_url.php'); print $rurl; ?>">
    </iframe>
    
  

IFrame内で上記のリダイレクトURLを呼び出し表示します。

結果

利用方法(例)

記事を選択するプルダウンメニューや目次を作成し、記事に対応した「contentId」を取得し表示させるなどの活用が考えられます。
ここでは、プルダウンメニューより記事を選択し「送信ボタン」を押すことで選択した記事がIFrame内に表示される例を紹介します。

利用例を新規ウィンドウ(または新規タブ)で開きます。

備考

記事内に掲載されている外部ホームページや画像へのリンクは基本的には target="_blank" が指定されています。

戻る