会員認証 - 状態確認 API

概要

{primary} KIZUNA申し込みメールの認証リンク押下して開いた画面で、認証可能かどうかを判定するAPIです。

エンドポイント

メソッド URI Headers
GET /api/verify Default

GETパラメータ

パラメーター名 型 内容 特記
email string メールアドレス KIZUNA HPの申し込みで入力したメールアドレス
verify_token string 認証トークン 申し込み時にKIZUNA-CMPSのAPIで生成されたトークン

レスポンス

成功時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 申し込みから2日以内かつ未認証の場合にtrue
errors array エラーメッセージ 成功のためエラーがないので空配列が返ってきます
alert array アラート 成功のためエラーがないので空配列が返ってきます
data[organization_id] int 監理団体ID 未認証の場合はまだorganization_idが発行されないためnullを返します。
data[is_verified] boolean 認証済みか？ 未認証の場合はfalseを返します。 
{
    "data": {
        "organization_id": null,
        "is_verified": false
    },
    "result": true,
    "errors": [],
    "alert": []
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 認証済み または 認証可能なデータが存在しない場合はfalse
errors array エラーメッセージ エラーメッセージは返さないので空配列が返ってきます
alert array アラート アラートは返さないので空配列が返ってきます
data[organization_id] int 監理団体ID 既に認証済みの場合のみ、初回パスワード登録へリダイレクトするためのorganization_idを返します。
data[is_verified] boolean 認証済みか？ 既に認証済みの場合のみ、trueを返します。この値がtrueの場合は認証画面をスキップして初回パスワード登録画面へリダイレクトします。 
// 認証済みの場合
{
    "data": {
        "organization_id": 11,
        "is_verified": true
    },
    "result": false,
    "errors": [],
    "alert": []
}

// 認証可能なデータが存在しない場合
{
    "data": {
        "organization_id": null,
        "is_verified": false
    },
    "result": false,
    "errors": [],
    "alert": []
}

その他

↓現行KIZUNAの認証不可の場合の表示blade

@extends('layouts.error')

@section('content')
  <article>
    <div class="codeBox">
      <h1 class="codeBox_title"><i class="fas fa-robot fa-lg fa-fw"></i>&nbsp;Verify Error!!</h1>
      <p class="codeBox_text">このURLは無効です。</p>
      <div class="textBox textBox-spaceM">
        <p class="textBox_text textBox_text-positionCenter">KIZUNAの認証URLは<b style="font-size: 1.6rem; color: #f13757;">翌日の24時まで有効</b>となっております。</p>
        <p class="textBox_text textBox_text-positionCenter textBox_text-spaceXS">有効期限切れ等で上記のURLが無効になってしまった場合は、お手数おかけいたしますが再度お申込みください。</p>
        <p class="textBox_text textBox_text-positionCenter textBox_text-spaceS">※翌日の24時を過ぎますと認証URLは無効となります。</p>
        <p class="textBox_text textBox_text-positionCenter textBox_text-spaceS">※複数回お申込みを行った場合、最後に発行された認証URLのみ有効となります。</p>
      </div>
      <div class="block block-positionCenter block-spaceM">
        <a href="javascript:history.back();" class="button button-sizeM button-color4 button-icon button-iconBack" tabindex="1">戻る</a>
      </div>
    </div>
  </article>
@endsection
@section('script')
<script>
</script>
@endsection