CliqをHRMSソフトウェアに統合する

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

このドキュメントは、HRMSソフトウェアとZoho Cliqの連携をサポートします。

Zoho OAuthを使用した認証の確立

認証は安全なデータ連携に不可欠であり、Zoho OAuthは標準化されたプロトコルを提供します。HRMSソフトウェアとZoho Cliqを接続する前に、2つのアプリ間で認証を確立する必要があります。

Zoho Cliqで認証を確立するには、APIドキュメントに記載された手順に従ってください。

まず、Zoho CliqとHRMSソフトウェア間で認証接続を作成する必要があります。Zoho CliqのRest APIはOAuth 2.0プロトコルを利用してリクエストの認可と認証を行います。各APIリクエストにはOAuthトークンの付与が必須となり、正しいレスポンスを受け取るために必要です。すべてのAPIリクエストはHTTPSで実施する必要があります。HTTPでの通信や認証なしのAPI利用は失敗します。

メモ:トークンの生成および更新には、ドメイン固有のZoho Cliq URLを必ず使用してください。

OAuthトークンの生成

OAuthトークンを生成するには、以下の手順に従ってください。

手順1：クライアントIDとクライアントシークレットの生成

アプリケーションを新規クライアントとして登録するには、次のWebサイトにアクセスします。

https://accounts.zoho.com/developerconsole

メモ: 登録時には必ずドメイン固有のZohoアカウントURLを使用してください

「クライアントIDを追加」をクリックし、以下を入力します：

クライアント名
クライアントドメイン
認証済みリダイレクトURI

「作成」をクリックします

必要な登録情報を入力すると、アプリケーション用のOAuth認証情報（クライアントIDとクライアントシークレット）が発行されます。これらの認証情報はZohoとアプリケーションの双方で保持されます。

手順2：承認のためのグラントトークン発行

ユーザーを認可URLにリダイレクトし、「ユーザー同意」ページでユーザーがアクセスを許可すると承認が完了します。認可URLは次の通りです：https://accounts.zoho.com/oauth/v2/auth

手順3：アクセストークンおよびリフレッシュトークンの生成

手順2のレスポンスで取得したコードパラメータの値を使用し、アクセストークンおよびリフレッシュトークンを生成します。

API一覧

HRMSソフトウェアとの同期に必要となる主なAPIは以下の通りです。

API経由でZoho Cliqにユーザーを追加
特定ユーザーの項目をAPI経由でZoho Cliqにて更新
API経由で特定ユーザーを有効化・無効化
チームへのメンバー追加
チームからメンバーの削除
部署へのメンバー追加
部署からメンバーの削除

API経由でZoho Cliqにユーザーを追加: このAPIを利用することで、Zoho Cliqに1名または複数のユーザーを追加できます。

Zoho Cliqで特定のユーザーのユーザー項目をAPI経由で更新する：特定のユーザーのユーザー項目をZoho Cliqで更新するには、「更新するユーザーAPI」ドキュメントを参照してください。カスタム項目の一意の名前をキー名として対応する値とともに渡してください。カスタム項目の一意の名前を取得するには、Retrieveユーザー-項目APIを使用します。

メモ：

日付およびドロップダウン種類のカスタム項目については、指定されたフォーマットに従ってください。
日付：時間はミリ秒単位で入力してください（例：'dob': 1640592764071）。
ドロップダウン：ドロップダウン項目の選択肢を指定する場合は、オプションIDを使用します。利用可能な設定の一覧を取得するには、retrieve userfield APIを使用してください。

Zoho Cliqで特定のユーザーをAPI経由で有効化・無効化する：ユーザーを有効または無効にするには、以下のAPI（指定のURL、メソッド、リクエスト本文）を使用します。