Paycor RESTコネクター
APIドキュメント
Section titled “APIドキュメント”このコネクターのエンドポイントについては、ベンダーのAPIリファレンスを参照してください。
Paycorのセットアップ
Section titled “Paycorのセットアップ”Paycor APIのアプリケーション登録と開始のプロセスは、他のRESTプロバイダーよりも少し手間がかかります。必ず、Paycorのクイックスタートページに記載された手順を最後まで実施してください。
必ず控えておく必要がある主な値は次のとおりです。
- アプリケーションのOAuthクライアントID
- アプリケーションのOAuthクライアントシークレット
- APImサブスクリプションキー
currentアプリケーションバージョンのスコープキー
必要に応じて本番またはサンドボックスを選択し、次の場所でアクティブ化します。
| 環境 | アクティベーションフォームのURL |
|---|---|
| サンドボックス | https://hcm-demo.paycor.com/AppActivation/ClientActivation |
| 本番 | https://hcm.paycor.com/AppActivation/ClientActivation |
この接続の作成時または編集時に、次のフィールドが表示されます。
| フィールド | タイプ | 説明 |
|---|---|---|
| 名前 | テキスト | この接続の表示名。 |
| エイリアス | テキスト(複数行) | 接続に関する任意のエイリアスまたはメモ。 |
| 有効 | トグル | 接続を有効にするかどうか。削除せずに一時停止するには無効にします。 |
| DB読み取り専用 | トグル | 接続を読み取り専用の操作に制限します。 |
| アクセスタイプ | 選択 | この接続の読み取り専用、書き込み専用、読み取り/書き込みのいずれかのアクセスレベル。 |
Paycorのセットアップで控えた3つの値を入力します。ホストやトークンURLを入力する必要はありません。PaycorのAPIホストとOAuth2トークンエンドポイントはPlaidCloudが提供します。
| フィールド | タイプ | 説明 |
|---|---|---|
| OAuth2クライアントID | テキスト | Paycorアプリ登録のアプリケーションOAuthクライアントID。 |
| OAuth2クライアントシークレット | パスワード | アプリケーションOAuthクライアントシークレット。暗号化して保存されます。 |
| Paycorサブスクリプションキー | テキスト | Paycorアプリケーションの APIm サブスクリプションキー。 |
PaycorはOAuth2の認可コードグラントを使用するため、資格情報の入力は前半にすぎません。PlaidCloudにデータの取得を許可する、Paycorでの1回限りのログインも完了する必要があります。
- 資格情報を入力して保存します。 上記の3つの値を入力し、接続を保存します。
- 接続します。 Paycorに接続をクリックします。PlaidCloudがPaycor認可ウィンドウを開きます。このボタンは、接続を保存すると使用できるようになります。
- ログインして承認します。 そのウィンドウでPaycorにサインインし、アクセスを承認します。Paycorからの戻り先はPlaidCloudとなり、接続にリフレッシュトークンが保存され、以降はそれを使用してアクセストークンが自動的に取得されます。
APIホスト(apis.paycor.com)とトークンエンドポイント(https://apis.paycor.com/sts/v1/common/token)はPlaidCloudが管理します。入力するURLフィールドはなく、編集する必要もありません。
期限切れの接続を再認可する
Section titled “期限切れの接続を再認可する”Paycorへのアクセスは失効することがあります。リフレッシュトークンが期限切れになるか取り消された場合や、Paycorアプリケーションが非アクティブ化された場合です。その場合、接続を使用するワークフローは認証できなくなり、失敗します。復旧するには、次の手順を行います。
- Paycorアプリケーションがまだアクティブ化されていることを確認します(PaycorのセットアップのアクティベーションURLを参照)。
- 接続を開いてPaycorに接続をクリックし、Paycorの認可を再実行して、ログインして承認します。これで新しいリフレッシュトークンが発行され、接続が再開されます。