Important Instructions

Usage Steps

1. Purchase Premium Version, or apply for Premium Version trial. See Integration Process for details;
2. Get your team's appid and secret from [Workspace Top-right Corner - Avatar - Team Management - Click Team Name - API Service - Enable Service - View Credentials];
3. Use appid and secret to call the authorization API to obtain access_token. The access_token is valid for 2 hours, refer to API Authorization;
4. Use appid and access_token to call more APIs to read and write user data.
   All API requests need to include parameters ?appid={appid}&access_token={access_token}, do not include the brackets {} when calling;
5. We recommend using Postman API Cases and Postman API Documentation for API debugging.

API Domain

https://open.wesurvey.com

API Example

https://open.wesurvey.com/api/surveys?appid=xxxx&access_token=xxxx&user_id=50000000001

Request Specifications

1. All API endpoints communicate via HTTPS and use UTF-8 encoding
2. Supported HTTP request methods: POST, GET, DELETE
3. Supported Content-Type for POST requests: application/json. Parameters marked as body in subsequent documentation should be sent as JSON

Parameter Types

The API includes three types of parameters:

1. uri: in the request route, like GET /api/surveys/123456?appid=xxxx&access_token=xxxx
2. queryString: after ?, like GET /api/surveys?appid=xxxx&access_token=xxxx&openid=abcdefg
3. body: in POST request body, sent as standard JSON, like POST /api/users?appid=xxxx&access_token=xxxx {"user_id":654321}

Additional Notes

If your platform provides services to multiple enterprises and teams, and a single appid does not meet your needs, please scan the QR code to contact customer service for information about Platform Partnership, Premium Version, or Enterprise Version.