StyleflowのOAuth認証におけるアクセストークンの取得方法について詳しく説明します。アクセストークンは、StyleflowのAPIにアクセスするために必要な認証トークンです。
📋 アクセストークンとは
アクセストークンは、StyleflowのAPIリソースにアクセスするための認証トークンです。
💡 アクセストークンの特徴
- API認証:StyleflowのAPI呼び出し時に必須の認証情報
- 有効期限管理:password方式の場合60分の有効期限
- Bearer認証:HTTPヘッダーでBearer認証として使用
- スコープ制御:取得時に指定したスコープに応じたアクセス権限
🚨 重要な前提条件
- 事前にStyleflowでアプリケーションを登録済みであること
- Client IDとClient Secretが準備されていること
- 認可コードフローの場合:認可コードが取得済みであること
🔄 アクセストークン取得方法
Styleflowでは2つの方法でアクセストークンを取得できます:
| 取得方法 | grant_type | 説明 |
|---|---|---|
| 認可コードフロー | authorization_code | 認可コードを使用した安全な方法 |
| パスワード認証 | password | ユーザーID・パスワードを直接使用 |
⚙️ アクセストークン取得手順
推奨シーン:認可コード取得後、またはパスワード認証でのAPI利用時
基本手順
- トークンエンドポイントへのリクエスト
以下のURLにPOSTリクエストを送信:https://www.styleflow.jp/kumade/styleflow/oauth/token.action - HTTPヘッダーの設定
Content-Type: application/x-www-form-urlencoded - リクエストボディの設定
grant_typeに応じてパラメータを設定
🔐 方法1:認可コードフロー
📋 必須パラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
| grant_type | ○ | 「authorization_code」を指定 |
| code | ○ | 認可コード取得で取得したcode |
| client_id | ○ | アプリケーション登録時のClient ID |
| client_secret | ○ | アプリケーション登録時のClient Secret |
| redirect_uri | ○ | 認可コード取得時と同じリダイレクトURI |
🔑 方法2:パスワード認証
📋 必須パラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
| grant_type | ○ | 「password」を指定 |
| username | ○ | StyleflowのユーザーID(ユーザーID@ドメインID) |
| password | ○ | 対応するパスワード |
| client_id | ○ | アプリケーション登録時のClient ID |
| client_secret | ○ | アプリケーション登録時のClient Secret |
| scope | ○ | アクセス制御情報をスペース区切りで指定 |
| redirect_uri | ○ | アプリケーション登録時のリダイレクトURI |
📝 リクエストボディサンプル
認可コードフロー例
grant_type=authorization_code&
code=your_authorization_code&
client_id=your_client_id&
client_secret=your_client_secret&
redirect_uri=https://example.com/callback
code=your_authorization_code&
client_id=your_client_id&
client_secret=your_client_secret&
redirect_uri=https://example.com/callback
パスワード認証例
grant_type=password&
username=user@domain&
password=userpassword&
client_id=your_client_id&
client_secret=your_client_secret&
scope=applyDocument.read&
redirect_uri=https://example.com/callback
username=user@domain&
password=userpassword&
client_id=your_client_id&
client_secret=your_client_secret&
scope=applyDocument.read&
redirect_uri=https://example.com/callback
📨 レスポンス仕様
🟢 成功時のレスポンス
✅ レスポンス形式
{
"access_token": "generated_access_token",
"token_type": "bearer",
"scope": "applyDocument.read"
}
"access_token": "generated_access_token",
"token_type": "bearer",
"scope": "applyDocument.read"
}
| フィールド | 説明 |
|---|---|
| access_token | 発行されたアクセストークン |
| token_type | 常に「bearer」 |
| scope | 指定したスコープ |
⏰ 有効期限について
- password方式:取得したアクセストークンの有効期限は60分
- authorization_code方式:有効期限の記載なし(永続的な可能性)
🔴 エラー時のレスポンス
❌ エラーの種類
| エラーコード | 説明 |
|---|---|
| invalid_grant | codeが不正な場合 |
| invalid_request | client_idまたはclient_secretが不正な場合 |
🛠️ アクセストークンの使用方法
APIリクエストでの使用
取得したアクセストークンを使用してStyleflowAPIにアクセスします:
🔗 HTTPヘッダー設定
Authorization: Bearer your_access_token
実際のAPIリクエスト例:
curl -H "Authorization: Bearer your_access_token" \
https://www.styleflow.jp/kumade/styleflow/api/v1/documents
✅ ベストプラクティス
| 🔐 | トークン管理:アクセストークンは機密情報として厳重に管理 |
| ⏰ | 有効期限監視:password方式は60分以内の使用期限を考慮 |
| 🎯 | 適切なスコープ:必要最小限のスコープでトークンを取得 |
| 🔄 | トークン更新:有効期限切れ前の適切なトークン再取得 |
| 🛡️ | HTTPS必須:すべてのAPI通信でHTTPSを使用 |
🚀 次のステップ
⚡ アクセストークン取得後の活用
- API呼び出し:StyleflowAPIでリソースにアクセス
- 詳細な利用方法:別紙「【Styleflow】操作マニュアル-StyleflowAPI」を参照
- 実際の開発:取得したトークンを使用したアプリケーション開発
🎯 まとめ
アクセストークンの取得により、StyleflowのAPIを安全に利用できるようになります。
🔑 成功のポイント
- 適切な認証方式選択:認可コードフローまたはパスワード認証の適切な選択
- 正確なパラメータ設定:必須パラメータの漏れない設定
- セキュリティ重視:トークンの適切な管理と有効期限の考慮
アクセストークンを取得したら、StyleflowAPIを使用して様々なリソースにアクセスし、効率的なシステム連携を実現しましょう。