データ連携/開発者向けサイトについて
開発者向けサイトとは
開発者向けサイトでは、外部サービス連携に必要な情報取得が可能です。
こちらは情報システム担当者様向けのサイトとなっております。
- HRBrainのAPI仕様書の確認
- 他サービスとの連携用のトークン発行
などが可能です。
目次
・開発者向けサイトを利用できる人
・開発者向けサイト内の権限付与の方法
・アクセス方法
・各種設定の操作手順
1）公開API/Token設定
2）公開API ドキュメント
3）SCIM設定
4）Webhook設定
開発者向けサイトを利用できる人
開発者向けサイトは、開発者向けサイト内の権限を持つメンバーが利用できます。
テナント作成時に、一番最初に登録された担当者に開発者向けサイト内のオーナー権限が付与されます。
権限付与されているメンバーがわからず確認ができない場合は、ヘルプデスクにお問い合わせください。
権限を持つメンバーを増やしたい場合は、以下の手順に従って設定を行ってください。
開発者向けサイト内の権限付与の方法
開発者向けサイトにアクセスできる方を追加できます。
1．[開発者向けサイト] > [権限設定] > [管理者追加]をクリックします
2．①権限範囲を確認します
3．②「従業員番号」「メールアドレス」「氏名」で検索します
4．③該当の方を[追加]します
追加された方は、開発者向けサイトにアクセスできるようになります。
※HRBrain内で、シートの閲覧範囲等に影響が出ることはありません。
※[オーナー]権限を付与された方は[公開API Token設定][公開API Webhook設定][公開API Documentのみ][SCIM設定]の権限も保持します。
アクセス方法
画面右上のグローバルメニューから、[開発者向けサイト]をクリックします。
[開発者向けサイト]をクリックすると、上の機能一覧が表示されます。
各種設定の操作手順
1）公開API/Token設定
利用できるのは[オーナー]権限または[公開API Token設定]権限保有者です。
1．[開発者向けサイト] > [公開API/Token設定] > [トークン作成]をクリックします
2．①[名前]に任意のトークン名を入力します
3．②[スコープ]に任意の項目をチェックします
4．③[作成]をクリックします
上記の作業を完了すると、トークンが生成されます。
※このトークンは一度のみ表示されるので、コピーして大切に保存してください。
2）公開API ドキュメント
利用できるのは[オーナー]権限または[公開API Documentのみ]権限保有者です。
画面左の各カテゴリ毎に、APIドキュメントが表示されます。
必要な情報を取得し、連携機構の開発等にご利用ください。
3）SCIM設定
利用できるのは[オーナー]権限または[SCIM設定]権限保有者です。
SCIM連携に必要なトークンを取得することができます。
1．[開発者向けサイト] > [SCIM設定] > [トークン作成]をクリックします
2．[名前]に任意のトークン名を入力します
上記の作業を完了すると、トークンが生成されます。
※このトークンは一度のみ表示されるので、コピーして大切に保存してください。
4）Webhook設定
利用できるのは[オーナー]権限または[公開API Webhook設定]権限保有者です。
HRBrainでメンバー情報の更新が行なわれた際に、指定したURLに通知が送信されるようになります。
1．[開発者向けサイト] > [Webhook設定] > [Webhook登録]をクリックします
2．Webhookの詳細設定を行います
① 名前：Webhook設定の設定名を入力します
② Webhook URL：通知用のURLを入力します
③ 通知条件：通知が送信されるトリガーとなる条件を選択します
④ Webhookの有効化：通知を止めたい場合は[無効]を選択します
設定内容を確認し、作成をクリックします
上記の作業を完了すると、トークンが生成されます。
※このトークンは一度のみ表示されるので、コピーして大切に保存してください。
以上でWebhookの設定は完了です。
関連ヘルプページ