StyleflowのAPIを利用するために必要なアクセストークンの取得方法について説明します。アクセストークンを取得することで、外部システムとStyleflowの連携が可能になります。
📊 APIアクセストークンとは
APIアクセストークンは、StyleflowのAPIを利用する際に必要な認証情報です。このトークンを使用することで、外部システムからStyleflowの各種機能にアクセスできるようになります。
⚠️ 取得前の確認事項
- APIアクセストークンの作成は、管理者による許可設定が必要です
- 設定画面が表示されない場合は、管理者にお問い合わせください
- 管理者設定の詳細は「【Styleflow】操作マニュアル-管理者向け APIアクセストークン作成許可を設定したい」をご覧ください
🔧 アクセストークンの取得手順
推奨シーン：API連携の初期設定時、新しいシステム連携を開始する際
手順
-
基本情報画面への移動
「基本情報」を押下し「社員情報」画面に遷移します。 -
APIアクセストークン一覧画面の表示
「APIアクセストークン｜一覧」画面にて「新規作成」ボタンを押下します。 -
アクセストークンの設定
「APIアクセストークン｜詳細」画面にて、以下の設定を行います：- アクセストークン名：わかりやすい名前を設定
- 使用するAPIのスコープ：必要な権限を選択（複数選択可能）
設定完了後、「登録」ボタンを押下します。
-
アクセストークンの確認と保存
「登録」ボタンを押下すると、アクセストークンが表示されます。
🎯 スコープの選択について
APIスコープは、アクセストークンで実行できる操作を制限する重要な設定です。
💡 主要なスコープ
- 申請書類関連：書類の参照、作成、削除
- 所管書類関連：所管書類の参照
- 保管書類関連：保管書類の参照
- マスタデータ関連：社員・部門・役職情報の操作
- フォーム・ワークフロー関連：フォーム項目やルート情報の参照
💡 スコープの詳細について
詳細については、OAuth認証で使用できるスコープ一覧とは？をご参照ください。
🔒 セキュリティ上の重要な注意事項
🚨 アクセストークンの取り扱い
- 一度のみ表示：アクセストークンは漏洩防止のため一度しか表示されません
- 必ず保存：表示された際に必ずメモを取るなどして安全に保管してください
- パスワードと同等の扱い：アクセストークンはパスワードと同様に大切に扱い、秘密にしてください
- 漏洩時の対応：第三者へ漏洩した可能性がある場合は、すぐにアクセストークンの削除を行ってください
⚡ 特別な権限が必要なAPI
📝 申請書類削除APIについて
- 「申請書類削除API」のアクセストークンは、管理者から特別な権限が付与されているユーザのみ取得可能です
- この権限を取得したい場合は、管理者にお問い合わせください
- 管理者設定の詳細は「【Styleflow】操作マニュアル-管理者向け APIアクセストークン作成許可を設定したい」をご覧ください
✅ 取得後の次のステップ
アクセストークンの取得が完了したら、以下を確認してAPI利用を開始してください：
| 📋 | API仕様書の確認：OpenAPI仕様書で詳細な仕様を確認 |
| 🔧 | リクエスト形式の確認：Authorizationヘッダーにbearer形式でトークンを設定 |
| 🧪 | テスト実行：まずは簡単なAPIから動作確認を実施 |
| 📖 | エラー対応：エラーコードとメッセージを参考に適切な処理を実装 |
🎯 まとめ
APIアクセストークンの取得により、StyleflowとのAPI連携が可能になります。
🔑 成功のポイント
- 適切なスコープを選択してセキュリティを確保
- アクセストークンの安全な管理と保管
- API仕様書を参考にした正確な実装
- 定期的なトークンの見直しと更新
API連携に関するご質問やサポートが必要な場合は、お気軽にお問い合わせください。