勤怠管理用のAPIがBioStar2.8.13で追加されました。
勤怠APIを使用するには、BioStar2.8.13をインストールまたは2.8.13にアップグレードが必要です。
勤怠API Swaggerにアクセスする方法
- [BioStar 2アドレス] + ':’ + (TNA httpsポート) + ‘/docs/#'
eg,) BioStar 2アドレスが「https://192.168.13.36」
TNA httpsポートが「3002」
勤怠API Swaggerアドレス> https://192.168.13.36:3002/docs/#
- ‘localhost’ + ':’ + (TNA httpsポート) + ‘/docs/#'
TNAのデフォルトhttpsポートは「3002」に設定されています。
また、Cookie情報を保存する必要はありません。
1. ログインする方法
> 2つのログイン方法があります。
- [POST] /login
- bodyのModelをクリックします。
- パラメーターが自動的に入力されます。
- 必須パラメータの"user_id","password"を入力します。
- Try it outをクリックします。
- [POST] /login/sso
*BioStar 2 New Local APIログインにて確認したbs-session-id値を入力してログインします。- bodyのModelをクリックします。
- パラメーターが自動的に入力されます。
- 必須パラメータの"user_id","password","biostar_session_id"を入力します。
- Try it outをクリックします。
正常にログインすると、ログインしたユーザーの情報が[Response Body]に表示され、[200]が[Response Code]に表示されます。
*bs-session-idに関しては以下のリンクをご確認ください。
[BioStar 2 API] BioStar 2.7.10のNew Local API
2. Postmanにてログイン
Postmanを使用して勤怠APIにログインする方法です。
[リクエスト例]
[レスポンス例: ボディ]
[レスポンス例: ヘッダー]
*他のAPI呼び出しで「be-session-id」値を入力する必要はありません。自動的に設定されます。
3. 勤怠APIその他機能
APIを使用して、タイムコード、シフト、スケジュールテンプレート、ルール、不在、打刻ログなどのデータを作成、取得、編集、削除できます。