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 サイトにアクセスし、アプリケーションを新規クライアントとして登録します。
メモ: 登録時には、ドメイン固有の Zoho アカウント URL を必ず使用してください。
- ［クライアントを追加］をクリックし、次の項目を入力します。
- クライアント名
- クライアントドメイン
- 認証済みリダイレクト URI
- ［作成］をクリックします。
必要な登録情報を入力すると、アプリケーション用の OAuth 資格情報としてクライアント ID とクライアントシークレットのセットが付与されます。これらの資格情報は Zoho とお客様のアプリケーションの両方で共有されます。
手順 2: グラントトークンを生成して認可を実行
ユーザーを認可 URL にリダイレクトし、ユーザーが「ユーザー同意」ページでアクセスを許可すると認可が完了します。認可 URL は次のとおりです。https://accounts.zoho.com/oauth/v2/auth
手順 3: アクセストークンとリフレッシュトークンの生成
手順 2 のレスポンスで取得した code パラメーターの値を使用して、アクセストークンとリフレッシュトークンを生成します。
API
HRMS ソフトウェアとの同期で利用する主な API は次のとおりです。
- API を使用して Zoho Cliq にユーザーを追加
- API を使用して Zoho Cliq の特定ユーザーのユーザー項目を更新
- API を使用して Zoho Cliq の特定ユーザーを有効化／無効化
- チームへのメンバー追加
- チームからのメンバー削除
- 部署へのメンバー追加
- 部署からのメンバー削除
API を使用して Zoho Cliq にユーザーを追加: この API を使用して、Zoho Cliq に 1 人または複数のユーザーを追加できます。
API を使用して Zoho Cliq の特定ユーザーのユーザー項目を更新: Zoho Cliq の特定ユーザーのユーザー項目を更新するには、「ユーザー更新」API ドキュメントを参照してください。カスタム項目の一意の名前をキー名として、対応する値とともに渡すようにしてください。カスタム項目の一意の名前を取得するには、「ユーザー項目取得」API を使用します。
メモ:
- 日付型およびドロップダウン型のカスタム項目については、指定された形式に従ってください。
- 日付: 時刻はミリ秒で指定します（例: 'dob': 1640592764071）。
- ドロップダウン: ドロップダウン項目内のオプションには、そのオプション ID を使用します。利用可能な設定の一覧を取得するには、ユーザー項目取得 APIを使用してください。
API を使用して Zoho Cliq の特定ユーザーを有効化／無効化: Zoho Cliq のユーザーを有効化または無効化するには、次の URL、メソッド、およびリクエスト本文で API を使用します。
- URL : /api/v2/users/{user_id}
- Method : PUT
- Scope : ZohoCliq.users.UPDATE
- Request 本文:
- {
- 'is_active': false/true
- }