「SHOHS でログイン」を自分のアプリに導入する方法

最終更新:

「SHOHS でログイン」はOAuth 2.0 Authorization Code Flowで導入します。Cloud Consoleで認証情報を取得し、認可エンドポイントへ誘導して得た認可コードをトークンと交換し、UserInfoでユーザー情報を取得する流れです。

このページの内容「SHOHS でログイン」を自分のアプリに導入する方法導入の流れ導入時の注意点よくある質問関連記事

「SHOHS でログイン」を自分のアプリに導入する方法

この記事では、自分のWebアプリやサービスに「SHOHS でログイン」の機能を組み込む流れを説明します。SHOHSのログインは、標準的なOAuth 2.0 Authorization Code Flow(OpenID Connectの一部を含む)で動作します。

導入の流れ

  1. SHOHS Cloud ConsoleでOAuth認証情報(Client ID / Client Secret)を取得します。手順は関連記事をご覧ください。
  2. ユーザーを認可エンドポイント(https://auth.shohs.net/oauth2/authorize.php)へ誘導します。その際、client_id、redirect_uri、response_type=code、必要なscopeを指定します。CSRF対策のstateを付けることと、PKCEの併用が推奨されます。
  3. ユーザーがログインして同意すると、登録したRedirect URIへ認可コード(code)が返ってきます。
  4. 受け取ったcodeをトークンエンドポイント(https://auth.shohs.net/oauth2/token.php)へ送り、アクセストークンを取得します。認可コードは1回限りで、有効期限も短く設定されています。
  5. アクセストークンを使ってUserInfoエンドポイント(https://auth.shohs.net/oauth2/userinfo.php)からユーザー情報を取得し、自分のアプリのアカウントと紐付けます。

導入時の注意点

  • Redirect URIは、Cloud Consoleに登録したものと完全一致(末尾のスラッシュの有無を含む)させる必要があります。一致しない場合は redirect_uri_mismatch エラーになります。
  • Client Secretはサーバー側でのみ保持し、ブラウザやモバイルアプリのコードに埋め込まないでください。
  • 公開範囲(内部/外部)は、アプリの利用者に合わせて設定してください。選び方は関連記事をご覧ください。

よくある質問

コード例はありますか?

cURL、JavaScript、PHP、Pythonのコード例が、SHOHS OAuth 2.0 開発者ドキュメントに掲載されています。

エラーコードの意味を知りたい

invalid_grant や redirect_uri_mismatch など、主なエラーへの対処は開発者ドキュメントの「エラーコード」と「トラブルシューティング / FAQ」にまとめられています。

関連記事

この情報は役に立ちましたか?