メインコンテンツへスキップ
本記事では、社内アプリを作成し、連絡先管理が提供するユーザー管理関連 API を使用して、企業の社員を作成・取得・更新・削除する方法を説明します。

完成イメージ

ユーザー情報画面は以下のとおりです。

統合フローの概要

本記事では、社内アプリを作成し、連絡先管理が提供するユーザー管理関連 API を使用して、企業の社員を作成・取得・更新・削除する方法を説明します。 ステップ 1:アプリ認証情報を取得し、クライアント ID と Client Secret を取得します。 ステップ 2:API 権限をリクエストし、連絡先管理関連 API の権限をリクエストします。 ステップ 3:アプリのアクセス認証情報を取得し、社内アプリの access_token を取得します。API 呼び出し時には、アクセストークンで呼び出し元の認証を行います。 ステップ 4:連絡先関連 API を呼び出します。
  1. サーバー API の ユーザー作成 を呼び出し、ユーザーを作成します。ユーザーの userid を取得します。
    • 社員をルート部門に追加する場合、API パラメータに 1 を渡します。本サンプルではルート部門への追加を採用しています。
    • 社員を特定の部門に追加する場合は、まず 子部門 ID リストの取得 API を呼び出して部門 ID を取得し、ユーザー作成 API の部門パラメータとして使用します。
  2. ユーザーの userid 情報をもとに、サーバー API の ユーザー詳細の照会 を呼び出し、ユーザーの詳細情報を取得します。
  3. ユーザーの userid 情報をもとに、サーバー API の ユーザー情報の更新 を呼び出し、ユーザー情報を更新します。
  4. ユーザーの userid 情報をもとに、サーバー API の ユーザー削除 を呼び出し、ユーザー情報を削除します。

前提条件

アプリの作成と設定 のフローを完了していること。

ステップ 1:アプリ認証情報を取得する

  1. 対象のアプリを選択し、アプリ詳細ページに移動して、ベーシック情報 > 認証情報とベーシック情報 をクリックします。
  2. クライアント ID と Client Secret を取得します。

ステップ 2:API 権限を追加する

開発設定 > 権限管理 をクリックし、権限検索ボックスに qyapi_manage_addresslistqyapi_get_department_list を入力して、権限をリクエストします。

ステップ 3:アプリのアクセス認証情報 access_token を取得する

重要

  • サーバー API の差異については、旧バージョン API VS 新バージョン API を参照してください。
  • サーバー API の SDK ダウンロードについては、サーバー SDK ダウンロードを参照してください。
ステップ 1 で取得したクライアント ID と Client Secret をもとに、アプリのアクセス認証情報を取得し、社内アプリの access_token を取得します。

ステップ 4:連絡先関連 API を呼び出す

  1. サーバー API の ユーザー作成 を呼び出し、ユーザーを作成します。ユーザーの userid を取得します。
    • 社員をルート部門に追加する場合、API パラメータに 1 を渡します。本サンプルではルート部門への追加を採用しています。
    • 社員を特定の部門に追加する場合は、まず 子部門 ID リストの取得 API を呼び出して部門 ID を取得し、ユーザー作成 API の部門パラメータとして使用します。
  2. ユーザーの userid 情報をもとに、サーバー API の ユーザー詳細の照会 を呼び出し、ユーザーの詳細情報を取得します。

説明

ユーザー詳細取得の戻り値の一部フィールドには一定の要件があります。ユーザー詳細の照会 API ドキュメントの戻りフィールドの説明を参照してください。
  1. ユーザーの userid 情報をもとに、サーバー API の ユーザー情報の更新 を呼び出し、ユーザー情報を更新します。

説明

ユーザー情報の更新 API は、現時点で携帯電話番号の更新には対応していません。
  1. ユーザーの userid 情報をもとに、サーバー API の ユーザー削除 を呼び出し、ユーザー情報を削除します。