Login interface

The user login interface supports various login methods, including website login, WeChat login, Google login, etc., used to verify the user's identity and return login credentials.

Points to note

• The API uses the POST method and requires data to be submitted in application/ format
• Support login on multiple platforms, including websites, WeChat, QQ, Google, etc.
• Website login requires a username and password
• WeChat login requires providing corresponding user information and credentials
• Google login requires obtaining a code through the OAuth process
• After login, the user information and login token are returned
• Supports the feature to remember login status

Request address

{域名地址}/api/login

Description:{域名地址}Replace it with your domain name, such ashttps://en.anqicms.com/api/login

Request Syntax

POST {域名地址}/api/login
Content-Type: application/json

Request parameters

Return parameters

data parameter

Usage Example

Website Login Request Example

POST /api/login HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

{
  "platform": "website",
  "user_name": "admin",
  "password": "123456",
  "remember": false
}

WeChat Login Request Example

POST /api/login HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

{
  "platform": "wechat",
  "code": "wechat_code",
  "avatar": "https://example.com/avatar.jpg",
  "nick_name": "微信用户",
  "gender": "1",
  "province": "广东",
  "city": "深圳",
  "county": "南山区",
  "encryptedData": "encrypted_data",
  "iv": "iv_value",
  "signature": "signature_value",
  "rawData": "raw_data"
}

Google Login Request Example

POST /api/login HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

{
  "platform": "google",
  "state": "your-generated-state-value",
  "code": "google-auth-code"
}

Google Login Full Process

1. Firstly, obtain the Google login redirection URL:

GET /api/google/url?state=your-state-value HTTP/1.1
Host: www.anqicms.com

1. Redirect to the returned Google authorization URL; after the user completes authorization, they will be redirected to the callback address

2. Get the authorization code on the callback page, call the login interface:

POST /api/login HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

{
  "platform": "google",
  "state": "your-state-value",
  "code": "authorization-code-from-google"
}

Front-end Google login implementation example

// 点击谷歌登录按钮时触发
$('#login-google-btn').click(function() {
  $.get("/api/google/url").then(res => {
    if (res.data) {
      // 保存state值，用于后续验证
      sessionStorage.setItem('state', res.data.state);
      // 跳转到谷歌授权页面
      window.location.href = res.data.url;
    }
  }, 'json');
});

// 检查URL中是否有code参数（授权回调时）
if (window.location.href.indexOf('code') > -1) {
  // 获取URL参数中的code和state
  var urlParams = new URLSearchParams(window.location.search);
  var code = urlParams.get('code');
  var state = urlParams.get('state');
  
  // 调用登录接口完成登录
  $.ajax({
    type: 'POST',
    url: '/api/login',
    data: JSON.stringify({
      platform: "google",
      "state": state,
      "code": code,
    }),
    contentType: "application/json",
    dataType: 'json',
    success: function (res) {
      if (res.code === 0) {
        console.log('Google登录成功', res);
        // 登录成功后的处理
        window.location.href = '/dashboard'; // 跳转到用户中心
      } else {
        console.error('Google登录失败', res.msg);
      }
    },
    error: function(xhr, status, error) {
      console.error('网络错误', error);
    }
  });
}

Response Example

{
  "code": 0,
  "data": {
    "id": 1000,
    "created_time": 1669012062,
    "updated_time": 1679536756,
    "parent_id": 0,
    "user_name": "admin",
    "real_name": "",
    "avatar_url": "uploads/202211/21/14f56760596b5328.webp",
    "email": "",
    "phone": "",
    "group_id": 2,
    "status": 1,
    "is_retailer": 0,
    "balance": 0,
    "total_reward": 0,
    "invite_code": "anqicms",
    "last_login": 1702912236,
    "expire_time": 1997404800,
    "extra": null,
    "token": "eyJhbGI1NiZXJJZUwNnVCI6IjEwMDAifQ.pLmYPvSajEWrF0FaUGDciOiJIUzIzNiIsILLZBCRm8fYewv49agxlTA26DwIsInR5cCI6IkpXVCJ9.eyJ0IjoiMTcwNTz",
    "group": null,
    "full_avatar_url": "",
    "link": ""
  },
  "msg": ""
}

Example of error response

{
  "code": -1,
  "msg": "用户名或密码错误"
}

error code