Skip to main content

Import Team Members via API

重要提示

该功能仅支持旗舰版、服务商合作使用，详情请联系客服

Overview​

This document describes how to import/sync team members using APIs. This is applicable for teams created through the WJX official website, and not applicable for WJX applications installed through Wecom (WeCom), Tencent Lexi, or other platforms.

Use Cases​

  • Organizations with existing IT systems who want their members to seamlessly access WJX after logging into their internal system, without requiring a second login
  • Organizations with existing organizational structures who want to maintain consistency within WJX

Implementation Details​

Preparation​

  1. Create a team through the official website (Workspace - Create Team)
  2. Understand team member role permissions, quantity limits, etc., and upgrade to Premium Version as needed: https://wesurvey.com/buy.html
  3. Obtain API access permission: https://wesurvey.com/docs/openapi/instructions

API Call Flow​

  1. Call the Register Third-party Account API, provide openid to link with your internal system, and obtain the account ID generated by WJX
  2. Call the Get Team ID API for subsequent account team joining
  3. Call the Create Group API for subsequent account grouping; if not needed, accounts can be placed in the root directory
  4. Call the Join Team/Group API. When admin quota is available, the account role will be set as Survey Admin; when quota is insufficient, it will automatically downgrade to Regular Member who cannot create or manage surveys
  5. Call the Update Member Role API to set specific accounts as Team Admin, Survey Admin, or Regular Member as needed
  6. Call the Get One-time Login Code API for silent login. The login timing is controlled by the organization. Please ensure users have already logged into your internal system to prevent data leakage or unauthorized access
  7. Construct URL with the one-time login code to guide users. Users will be silently logged into WJX and can navigate freely

Additional Notes​

Step 7 of the API call flow can be either a direct browser redirect or iframe embedding (iframe is only recommended for PC, as it may fail to login in WeChat or incognito mode) Implementation Details