会員認証 - 登録 API
概要
{primary} KIZUNA申し込みメールの認証リンク押下して開いた画面で、認証処理を行います。
エンドポイント
| メソッド |
URI |
Headers |
| POST |
/api/verify |
Default |
POSTパラメータ
| パラメーター名 |
型 |
内容 |
特記 |
| email |
string |
メールアドレス |
KIZUNA HPの申し込みで入力したメールアドレス |
| verify_token |
string |
認証トークン |
申し込み時にKIZUNA-CMPSのAPIで生成されたトークン |
レスポンス
成功時
ステータスコード:200
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
認証の登録処理に成功した場合はtrue |
| errors |
array |
エラーメッセージ |
成功のためエラーがないので空配列が返ってきます |
| alert |
array |
アラート |
成功のためエラーがないので空配列が返ってきます |
| data[organization_id] |
int |
監理団体ID |
organizationsテーブルが作成されるので、その主キーのIDを返します。 |
{
"data": {
"organization_id": 11,
},
"result": true,
"errors": [],
"alert": []
}
失敗時
ステータスコード:200
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
認証の登録処理に失敗した場合はfalse |
| errors |
array |
エラーメッセージ |
エラーメッセージは返さないので空配列が返ってきます |
| alert |
array |
アラート |
アラートは返さないので空配列が返ってきます |
| data[organization_id] |
int |
監理団体ID |
認証に失敗してorganizationsテーブルのレコードが作成されないので、nullを返します。 |
{
"data": {
"organization_id": null
},
"result": false,
"errors": [],
"alert": []
}