Client API Overview
BambooCloud IDaaS platform provides all client APIs. Before calling platform APIs, you need to understand the pre-development notes and calling process. This article provides all open APIs for different client scenarios for developers' reference.
General Captcha
| API Name | API Path | API Description |
|---|---|---|
| Get Captcha | /api/v2/sdk/captcha | Initializes the graphic captcha for human-machine verification |
| Verify Captcha | /api/v2/sdk/captcha/verify | After sliding the graphic captcha slider, call the verify captcha API |
| Get Country Codes | /api/v2/sdk/country-codes | Queries international area codes supported by the server |
| Send SMS Verification Code | /api/v2/sdk/sms/send | After human-machine verification, call the send SMS verification code API |
| Send Email Verification Code | /api/v2/sdk/email/send | After human-machine verification, call the send email verification code API |
Login
| API Name | API Path | API Description |
|---|---|---|
| Username Password Login | /api/v2/sdk/login | Login using username and password |
| Mobile Password Login | /api/v2/sdk/login/mobile-pwd | Login using mobile number and password |
| Email Password Login | /api/v2/sdk/login/email-pwd | Login using email and password |
| Email Verification Code Login | /api/v2/sdk/login/email-verify-code | Login using email and email verification code |
| Unified User Password Login | /api/v2/sdk/login/auth | Login authentication using unified user (username/mobile/email) and password |
| Mobile SMS Login | /api/v2/sdk/login/mobile-verify-code | Login using mobile and SMS |
| Mobile WeChat Authorized Login | /api/v2/sdk/login/wechat | Login using mobile WeChat authorization |
| Mobile Alipay Authorized Login | /api/v2/sdk/login/alipay | Login using mobile Alipay authorization |
| QQ Authorized Login | /api/v2/sdk/login/qq | Login using QQ |
| Weibo Authorized Login | /api/v2/sdk/login/weibo | Login using Weibo |
| Apple Authorized Login | /api/v2/sdk/login/apple | Login using Apple |
| WeChat Mini Program Login | /api/v2/sdk/login/wechat-miniprogram | Login using WeChat Mini Program |
| Alipay Mini Program Login | /api/v2/sdk/login/alipay-miniprogram | Login using Alipay Mini Program |
| One-Click Mobile Login | /api/v2/sdk/login/aliyun-mobile-auth | Login using one-click mobile |
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 or email operation |
| Social Account Login and Register Mobile or Email | /api/v2/sdk/social/register-bind | User has not bound system mobile number and logs in with social account |
| WeChat Mini Program Authorized Mobile Login and Register User | /api/v2/sdk/social/wechat-mobile-register-bind | If the user does not exist in the platform, create a user with the same mobile number authorized by WeChat Mini Program and bind with WeChat; otherwise bind the existing user 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 in the platform can the same mobile number authorized by WeChat Mini Program be successfully bound with WeChat. |
| Use Alipay Authorized Mobile Login and Register User | /api/v2/sdk/social/alipay-mini-mobile-register-bind | If the user does not exist in the platform, create a user with the same mobile number authorized by Alipay Mini Program and bind with Alipay; otherwise bind the existing user 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 in the platform can the same mobile number authorized by Alipay Mini Program be successfully bound with Alipay. |
| Get Bound Social Account List | /api/v2/sdk/social | Used to get the social accounts bound by the user |
| Social Account Unbind | /api/v2/sdk/social/unbind-account | Used for social account unbinding operation |
Password Management
| API Name | API Path | API Description |
|---|---|---|
| Skip Force 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, the user chooses to change the password |
| Query Whether Password Is Set | /api/v2/sdk/pwd/check-exist | When modifying personal password, call this API to get whether the user has set a password |
| Change Password | /api/v2/sdk/pwd/change | User changes own password after login |
| Retrieve Password by Mobile | /api/v2/sdk/pwd/update-by-mobile | When the user forgets the password, choose to retrieve it via mobile number |
| Retrieve Password by 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 Register User | api/v2/sdk/register/mobile-verify-code | Use mobile and SMS verification code for user registration |
| Email Verification Code Register User | api/v2/sdk/register/email-verify-code | Use email and verification code for user registration |
| Update Profile | /api/v2/sdk/profile/update | Modify personal information after user login |
| Update Personal Mobile | /api/v2/sdk/profile/update-mobile | Modify personal mobile number after user login |
| Update Personal Email | /api/v2/sdk/profile/update-email | Modify personal email after user login |
| Update User Mobile by WeChat Authorized Mobile | /api/v2/sdk/profile/update-mobile-by-wechat | When the user's mobile is not bound, call this API to update the current user's mobile number to the WeChat authorized mobile number |
| Logout | /api/v2/sdk/logout | Log out of current login |
| Account Cancellation | /api/v2/sdk/logoff | Call this API when the user cancels the account 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 id_token |