The Zhuyun IDaaS platform provides a complete list of client APIs. Before calling platform APIs, it is necessary to understand the pre-development notes and the calling process. This document provides all open APIs for different client scenarios for developers' reference.
General Verification Code
| API Name | API Path | API Description |
|---|
| Get CAPTCHA | /api/v2/sdk/captcha | Initializes the graphical CAPTCHA for human-machine verification |
| Verify CAPTCHA | /api/v2/sdk/captcha/verify | Calls the verify CAPTCHA API after sliding the graphical CAPTCHA slider |
| Get International Dialing Codes | /api/v2/sdk/country-codes | Queries the international dialing codes supported by the server |
| Send SMS Verification Code | /api/v2/sdk/sms/send | Calls the send SMS verification code interface after passing human-machine verification |
| Send Email Verification Code | /api/v2/sdk/email/send | Calls the send email verification code interface after passing human-machine verification |
Login
| API Name | API Path | API Description |
|---|
| Username and Password Login | /api/v2/sdk/login | Logs in using username and password |
| Mobile Number and Password Login | /api/v2/sdk/login/mobile-pwd | Logs in using mobile number and password |
| Email and Password Login | /api/v2/sdk/login/email-pwd | Logs in using email and password |
| Email Verification Code Login | /api/v2/sdk/login/email-verify-code | Logs in using email and email verification code |
| Unified User Password Login | /api/v2/sdk/login/auth | Authenticates and logs in using unified user credentials (username/mobile/email) and password |
| Mobile SMS Login | /api/v2/sdk/login/mobile-verify-code | Logs in using mobile number and SMS code |
| Mobile WeChat Authorization Login | /api/v2/sdk/login/wechat | Logs in using mobile WeChat authorization |
| Mobile Alipay Authorization Login | /api/v2/sdk/login/alipay | Logs in using mobile Alipay authorization |
| QQ Authorization Login | /api/v2/sdk/login/qq | Logs in using QQ |
| Weibo Authorization Login | /api/v2/sdk/login/weibo | Logs in using Weibo |
| Apple Authorization Login | /api/v2/sdk/login/apple | Logs in using Apple |
| WeChat Mini Program Login | /api/v2/sdk/login/wechat-miniprogram | Logs in using WeChat Mini Program |
| Alipay Mini Program Login | /api/v2/sdk/login/alipay-miniprogram | Logs in using Alipay Mini Program |
| Mobile One-Click Login | /api/v2/sdk/login/aliyun-mobile-auth | Logs in using mobile one-click login |
Social Accounts
| API Name | API Path | API Description |
|---|
| Social Account Bind Mobile or Email | /api/v2/sdk/social/bind | Used for social account binding mobile number or email operations |
| Social Account Login Registers Mobile or Email | /api/v2/sdk/social/register-bind | User is not bound to a system mobile number and logs in with a social account |
| WeChat Mini Program Authorized Mobile Login Registers User | /api/v2/sdk/social/wechat-mobile-register-bind | If the user does not exist on the platform, create a user with the same mobile number authorized by the WeChat Mini Program and bind it with WeChat; otherwise, use the existing user and bind it with WeChat; |
| Use WeChat Mini Program Authorized Mobile to Bind User | /api/v2/sdk/social/wechat-mobile-bind | Only when the user already has a mobile number on the platform, binding with WeChat using the same mobile number authorized by the WeChat Mini Program succeeds. |
| Use Alipay Authorized Mobile Login Registers User | /api/v2/sdk/social/alipay-mini-mobile-register-bind | If the user does not exist on the platform, create a user with the same mobile number authorized by the Alipay Mini Program and bind it with Alipay; otherwise, use the existing user and bind it with Alipay; |
| Use Alipay Authorized Mobile to Bind User | /api/v2/sdk/social/alipay-mini-mobile-bind | Only when the user already has a mobile number on the platform, binding with Alipay using the same mobile number authorized by the Alipay Mini Program can succeed. |
| Get Bound Social Account List | /api/v2/sdk/social | Used to get the social accounts the user has bound |
| Social Account Unbind | /api/v2/sdk/social/unbind-account | Used for social account unbinding operations |
Password Management
| API Name | API Path | API Description |
|---|
| Skip Forced Password Change | /api/v2/sdk/pwd/skip-update | If the password is about to expire and the user chooses to skip changing the password |
| Force Password Change | /api/v2/sdk/pwd/update | If the password has expired or is about to expire, and the user chooses to change the password |
| Check If Password is Set | /api/v2/sdk/pwd/check-exist | When changing personal password, call this interface to get whether the user has set a password |
| Change Password | /api/v2/sdk/pwd/change | User changes their own password after logging in |
| Retrieve Password via Mobile Number | /api/v2/sdk/pwd/update-by-mobile | When the user forgets the password, choose to retrieve it via mobile number |
| Retrieve Password via Email | /api/v2/sdk/pwd/update-by-email | When the user forgets the password, choose to retrieve it via email |
Self-Service
| API Name | API Path | API Description |
|---|
| Mobile SMS User Registration | api/v2/sdk/register/mobile-verify-code | User registration using mobile phone and SMS verification code |
| Email Verification Code User Registration | api/v2/sdk/register/email-verify-code | User registration using email and verification code |
| Update Personal Information | /api/v2/sdk/profile/update | Update personal information after successful user login |
| Update Personal Mobile Number | /api/v2/sdk/profile/update-mobile | Update personal mobile number after successful user login |
| Update Personal Email | /api/v2/sdk/profile/update-email | Update personal email after successful user login |
| Update User Mobile via WeChat Authorization | /api/v2/sdk/profile/update-mobile-by-wechat | When the user's mobile is not bound, calling this API updates the current user's mobile number to the WeChat authorized mobile number |
| Logout | /api/v2/sdk/logout | Log out of the current session |
| User Deletion | /api/v2/sdk/logoff | Call this API when deleting a user to completely remove the user from the system |
Token Management
| API Name | API Path | API Description |
|---|
| ID Token Refresh | /api/v2/sdk/sso/session-token/id-token | Refresh the id_token |
I am ready. Please provide the Markdown content you would like me to translate.
