User Interface
-
Login interface
User login interface, supporting various login methods, including website login, WeChat login, Google login, etc., used to verify user identity and return login credentials. Notes The interface uses the POST method and requires data to be submitted in application/ format It supports multiple platform logins, including website, WeChat, QQ, Google, etc. Website login requires username and password WeChat login requires corresponding user information and credentials Google login requires obtaining the code through the OAuth process -
Registration interface
User registration interface, used to create a new user account. Notes The interface uses the POST method, requires data to be submitted in application/ format Supports multiple registration methods, can use username and password or mobile phone number verification code to register May require graphic captcha verification After successful registration, user information and login credentials are returned The username, email or mobile phone number must be unique The request address {domain address}/api/register Note: {domain address} needs to be replaced with your domain address, such as https://www -
Get user details interface
Get the basic information and account details of a specified user, including username, contact information, account status, balance, and other relevant user data.Note that this interface uses the GET method and requires the target user's ID to query user details. Depending on the user's permissions, you may only be able to view your own information or information of users you have permission to view. It returns the user's basic information and account-related information. Request address {domain address}/api/user/detail Note: {domain address} should be replaced with your domain address, such as https://www.anqicms -
Update user information interface
Update the basic information of the currently logged-in user, including username, real name, personal introduction, email, and phone number, etc. Notes: This interface uses the POST method and requires data to be submitted in application/ format. The user must be logged in to call this interface. All parameters are optional, and only the fields that need to be updated can be updated. The username, email, and phone number may require uniqueness verification. After the update is successful, the operation result will be returned. Request address {domain address}/api/user/detail Note: {domain address} -
Get user group details interface
Retrieve detailed information about a specified user group, including group name, level, price, configuration information, and other related user group data. Notes: This interface uses the GET method and requires the user group ID to query the group details. It returns the basic information and configuration information of the user group. The configuration information includes sharing profits, superior profits, discounts, and expiration days settings. It may require specific permissions to access certain group information. Request address {domain address}/api/user/group/detail Note: {domain address} needs to be replaced with your domain address, such as -
Get User Group List Interface
Retrieve the list of all user groups in the system, including detailed information such as names, levels, prices, configurations, etc. Notes: This interface uses the GET method and can be accessed without logging in. It returns all available user group information in the system, including basic group information and configuration information. Configuration information includes settings such as sharing profits,上级收益, discounts, and expiration days. Request address {domain address}/api/user/groups Note: {domain address} needs to be replaced with your domain address, such as https://www -
Modify user password interface
Modify the password of the currently logged-in user, it is necessary to verify the correctness of the original password before updating to a new password. Notes: This interface uses the POST method, data needs to be submitted in application/ format, the original password and new password need to be provided, the user must be logged in, and identity needs to be verified through session or Token, the new password must meet security requirements (such as length, complexity, etc.), it may be necessary to log in again after the modification is successful, the request address is {domain address}/api/user/password Description: {domain address} -
Interface to Update User Avatar
Allow users to upload custom avatar images, supporting common image formats, used to update the avatar information in the user's personal profile. Notes This interface uses the POST method, requires data to be submitted in form-data format, requires the user to log in to call this interface, the uploaded file must be an image format (such as JPG, PNG, WEBP, etc.), file size and format may be limited, depending on the system configuration, after successful upload, the avatar of the currently logged in user will be automatically updated, request address {domain address}/api/user/avatar note -
Log out interface
The user logs out, clears the current login status and session information, supports returning HTML pages or JSON data format. -
Send Email verification interface
Send a verification email to the specified email address, which contains a verification link. The user clicks the link to complete the email verification. Notes The interface uses the POST method and requires data to be submitted in application/ format The interface is used to send a verification email to the specified email address The email contains a verification link, which the user clicks to complete the verification Supports various verification scenarios (email verification, password reset, etc.) A valid email address and verification status need to be provided The email sending is successful and a success message will be returned, but it is not guaranteed that the user will receive the email The request address -
Verify Email Address Interface
Verify the validity of the email address, supporting email verification and password reset in various scenarios. Notes: This interface is used to verify the validity of the email address, supporting multiple verification scenarios (email verification, password reset, etc.). Ensures the validity of the request source through token and code parameters, supporting return of or html format data. After successful verification, the corresponding operation will be executed according to the state parameter. Ensure that the domain address is correctly configured. Request address {domain address}/api/verify/email Note: {domain address} -
Reset User Password Interface
Reset user password through email verification, the user needs to provide the email address, new password, verification token and verification code. Notes The interface uses the POST method, and data needs to be submitted in application/ format Currently, the password can only be reset through email and needs to be used in conjunction with the email sending function The user needs to obtain the verification link first Provide the email sending verification token and code value The new password must meet the system password strength requirements Verification information has an expiration time limit, and a new verification email needs to be sent after expiration The request address -
Get Google login redirect address interface
Retrieve the redirect URL for Google OAuth login, used to implement third-party login functionality, and return the complete Google authorization URL for users to jump and log in. Notes The interface uses the GET method, parameters are passed through the URL query string to implement the Google OAuth third-party login functionality It supports custom state parameters to prevent CSRF attacks If the state parameter is not provided, the system will automatically generate The returned URL contains all the authorization parameters, and after the user accesses it, they can jump to the Google login page You need to configure the relevant parameters of the Google developer account in the background