Understanding uni.login: A Comprehensive Guide
Have you ever wondered how to implement a seamless login experience in your uni-app application? Look no further! In this detailed guide, I’ll walk you through the ins and outs of the uni.login API, providing you with a multi-dimensional understanding of its capabilities and usage.
What is uni.login?
uni.login is a powerful API provided by uni-app that simplifies the login process across various platforms. It encapsulates different login methods, including app phone number one-tap login, third-party login (WeChat, Weibo, QQ, Apple, Google, Facebook), and built-in login for various mini-programs.
How uni.login Works
When you call the uni.login API, it triggers a login process that varies depending on the platform you’re targeting. Here’s a general overview of the steps involved:
- The API requests a temporary login code (code) from the platform’s login service.
- You send this code to your server.
- Your server uses the code to obtain the user’s unique identifier (OpenID) and session key (sessionkey) through the auth.code2Session API.
- Your server generates a custom login state using the user’s identifier, which can be used for subsequent business logic and backend interactions.
It’s important to note that the session key should not be distributed to the client or exposed to external parties for security reasons.
Parameters of uni.login
The uni.login API accepts several parameters that allow you to customize the login experience. Here’s a breakdown of the key parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | String | No | Login service provider. If not set, a login list selection interface will be displayed. |
| scopes | String/Array | No | Authorization type. Default is authbase. Supports authbase (silent authorization), authuser (active authorization), and authzhima (Alipay mini-program). |
| timeout | Number | No | Timeout time, in milliseconds. Available for WeChat mini-program, Baidu mini-program, and JD mini-program. |
| success | Function | No | Callback function when the API call is successful. |
| fail | Function | No | Callback function when the API call fails. |
| complete | Function | No | Callback function when the API call is completed (whether successful or not). |
The success callback function returns the following parameters:
| Parameter | Description |
|---|---|
| authResult | Login information provided by the login service provider. The results may vary depending on the service provider. |
| errMsg | Description of the information. |
Platform-Specific Considerations
uni.login supports various platforms, each with its own set of login methods and considerations. Here’s a brief overview of the supported platforms and their login methods:
| Platform | Login Methods |
|---|---|
| App Platform | App phone number one-tap login, third-party login (WeChat, Weibo, QQ, Apple, Google, Facebook), and built-in login for various mini-programs.
由 google |