Paylocity
Paylocity
Prerequisites
Before you can authenticate to Paylocity via OAuth, you must first obtain API access and register your desired callback URL with Paylocity. The callback URL for CData Connect Cloud is https://oauth.cdata.com/oauth/.
To register, contact either service@paylocity.com or sales@paylocity.com.
Once your access has been reviewed and approved, Paylocity provides you with OAuth credentials and access to either a Sandbox or a Production account. This access is necessary for authenticating your API requests.
Paylocity provides the following OAuth credentials.
-
client_id: The client_id assigned to the registered OAuth application in the Paylocity developer portal. This value is used to set the OAuthClientId.
-
secret: The secret assigned to the registered OAuth application in the Paylocity developer portal. This value is used to set the OAuthClientSecret. Note that Paylocity requires secrets to be rotated every 365 days. They send an email reminder of your secret expiring at 10 days before expiration and again at 5 days before expiration.
セットアップガイド
以下の手順で、Paylocity をCData Connect Cloud アカウントに接続します。
-
CData Connect Cloud のダッシュボードからConnections ページを開きます。
-
右上の+ Add Connection をクリックします。
-
検索フィールドに Paylocity と入力し、データソース名をクリックします。
-
新しいコネクションのBasic Settings タブで、コネクション名を入力するかデフォルトの名前をそのまま使用します。
-
Enter the following information:
-
OAuth Client Id–set to the client Id obtained in the prerequisites.
-
OAuth Client Secret—set to the client secret obtained in the prerequisites.
-
RSA Public Key—the RSA key associated with your Paylocity account. Only required if you want to execute Insert and Update statements.
-
Key—set this to the Base64-encoded AES symmetric key to use when encrypting content. Only required if the IV is set.
-
IV—set this to the Base64-encoded AES initialization vector (IV) to use when encrypting content. Only required if Key is also set.
-
Data Credentials–select how you want other users to access the data to this data source, either with shared credentials or with individual credentials.
-
-
CData Connect Cloud Add Paylocity Connection ページ上部の、Save & Test をクリックします。
-
接続テストに成功すると、コネクションが作成されたことを示すConnection successfully saved というメッセージが表示されます。Edit Connection ページのStatus もAuthenticated に変わります。Edit Connection ページの右ペインにあるData Model タブで、成功したコネクションのデータモデルを表示します。
-
接続テストに失敗した場合は、入力したログイン情報に余分なスペースや文字がないかを確認してください。CData Connect Cloud は、データが不足している必須フィールドの下にエラーメッセージを表示します。一部のデータソースでは、ソースのWeb サイトに直接サインインする必要があります。サインインしていない場合は、Sign in ボタンの下にエラーメッセージが表示されます。エラーを修正し、もう一度試してください。
-
失敗したコネクションは下書きとして保存され、Status はNot Authenticated になります。後でコネクションに戻って認証することができます。
-
詳細について
CData Connect Cloud とPaylocity の連携の詳細動作については、こちらのページを参照してください。