概要
💡 Josysでは、APIを公開しています。本機能を利用することで、APIを活用して自動でJosysに外部データを取得すること、Josysのデータの取得が可能となります。
利用方法の詳細については、APIドキュメント(Josys APIの仕様についてのドキュメント)をご確認ください。
ご利用いただけるお客様
ご契約のすべてのお客様でご利用いただけます。
IDトークン(APIキー)の発行方法
-
メニュー > デベロッパー > REST APIをクリック。右上の「作成」ボタンをクリックする。 - ラベル名を入力後、「作成」ボタンをクリックする。
- 「APIユーザーキー」と、「APIシークレットキー」が表示されるので、コピーし保存をする。
⚠️ 「APIシークレットキー」は再表示が出来ないため、必ず保管をお願いいたします。
主要SaaSとのAPI連携手順
連携手順については下記をご確認ください。
注意事項
⚠️旧バージョンのJosys API(v1)は、2025年2月末に提供を終了しました。
現在のJosys APIでは、メンバーのAPIのURLは
現在のJosys APIでは、メンバーのAPIのURLは
/api/v2/ で始まり、それ以外のAPIのURLは /api/v1/ で始まります。/api/v1/ で始まるAPIも、提供を終了した旧API(v1)ではなく、現在サポートしているAPIですので、そのままご利用いただけます。各APIの詳細はAPIドキュメントをご確認ください。APIごとのURL
エンドポイント https://developer.josys.it に、下記のパスを連結してご利用ください。
| 対象 | パス |
|---|---|
| トークンの発行 | /api/v1/oauth/tokens |
| メンバー(作成・取得・更新・削除・検索、カスタム項目、カスタムアプリの割り当て) |
/api/v2/user_profiles から始まるパス |
| メンバーに割り当てられている連携アプリの取得 | /api/v1/data/user_profiles/{uuid}/apps |
| 連携アプリ・カスタムアプリ |
/api/v1/data/integrated_apps、/api/v1/data/tracked_apps から始まるパス |
| 拠点 |
/api/v1/work_locations から始まるパス |
| 部署 |
/api/v1/departments から始まるパス |
| デバイス |
/api/v1/devices から始まるパス |
在籍ステータスの値
旧API(v1)から現在のメンバーのAPIへ移行した際に、在籍ステータスの値が以下のとおり変更されています。旧API(v1)向けに作成したプログラムをお使いの場合は、値を読み替えてください。
| 画面上の表記 | 旧API(v1) | 現在のAPI(v2) |
|---|---|---|
| 入社前 | ONBOARDED_INITIATED |
INITIATED |
| 在籍中 | ONBOARDED |
ACTIVE |
| 休職中 | TEMPORARY_LEAVE |
SUSPENDED |
| 退職済 | OFFBOARD_INITIATED |
TERMINATED |
| 不明 | UNKNOWN |
UNKNOWN |
| 削除済 | DELETED |
DELETED |
| その他 | OTHERS |
OTHERS |
よくある質問
Q: 読み取り専用など、権限を絞ったAPIキーを発行できますか?
APIキーごとに読み取り専用などの範囲を設定する機能はありません。APIキーには、発行した管理者アカウントの権限がそのまま適用されます。
なお、メンバーとデバイスのAPIは、データの取得を含めて、発行した管理者アカウントに「メンバー管理者」「ITデバイス管理者」(CSVダウンロードができる権限)が必要です。「閲覧者」や「(CSVダウンロード不可)」の権限で発行したAPIキーでは、403エラーとなります。Q: Josys APIにレート制限はありますか?
目安として、1組織あたり毎秒約4リクエストとなっております。Q: Josys APIで取得できるデータはいつ時点のものですか?
その時点でJosysに保存されている最新のデータを取得します。管理画面に表示されるデータと同じデータを取得するため、連携済みのアプリから取り込む情報は、Josysの自動同期または手動同期のタイミングに依存します。Q: デバイスの検索APIで取得できる件数に上限はありますか?
デバイスの検索(POST /api/v1/devices/search)で取得できるのは、条件に一致したデバイスのうち25,000件までです。25,000件を超える場合は、検索条件を絞り込んで複数回に分けて取得してください。