アクセストークンの発行方法

SmartHR APIを使用する際に必要なアクセストークンの発行方法を説明します。

1. ［アプリ一覧］の［共通設定］>［外部システム連携］を押す

［アプリ一覧］の［共通設定］を押します。画面左側に表示される共通設定の一覧から［外部システム連携］を押すと、外部システム連携画面が表示されます。

2.［アクセストークン］を押す

［アクセストークン］を押すと、アクセストークンの一覧画面が表示されます。

画像を表示する

3. ［+新規発行］を押す

画面右上にある［+新規発行］を押すと、アクセストークンの追加画面が表示されます。

画像を表示する

4. ［アクセストークン名］を入力し、［登録］を押す

［アクセストークン名］を入力し、［登録］を押すと、アクセストークンが発行されます。

任意で、［メモ］、［リソースのアクセス許可］、［従業員項目のアクセス許可］を設定できます。

画像を表示する

［リソースのアクセス許可］で設定できること

APIやWebhookから各リソースへのアクセス許可を設定できます。

従業員情報、共通設定、招待、アプリケーション連携に関する機能について、［参照］と［更新］の操作を許可できます。

機能分類	対象項目
従業員情報に関する機能	従業員情報（/crews） ※従業員項目とカスタム従業員項目が含まれます。 ※本項目を制限した場合、連動して［従業員項目のアクセス許可］の操作も制限されます。
共通設定に関する機能	会社情報（/companies）
	事業所（/biz_establishments）
	アカウント（/users）
	雇用形態（/employment_types）
	部署（/departments）
	役職（/job_titles）
	等級（/grades）
	職種（/job_categories）
	給与支給形態（/payment_periods）
	続柄（/dependent_relations）
	口座情報（/bank_account_settings）
	カスタム従業員項目（/crew_custom_field_template*）
	給与明細（/payrolls）
	源泉徴収票（/tax_withholdings）
	バックグラウンド処理（/batch_job*）
招待に関する機能	従業員招待フォーム（/crew_input_forms）
	メールフォーマット（/mail_formats）
アプリケーション連携に関する機能	Webhook（/webhooks）

［従業員項目のアクセス許可］で設定できること

/api/v1/crewsで取得できる項目を個別に許可できます。

リソースのアクセス許可で「従業員情報（/crews）」の［参照］［更新］の制限を設定している場合は、連動して本項目の操作も制限されます。

5. アクセストークンを取得する

［コピー］を押すと、アクセストークンがクリップボードにコピーされます。

画像を表示する