README

Usora是一个包含认证、用户设置、用户信息和单点登录的用户管理系统。

• Usora
  • 单点登录
    • 工作原理
  • API参考
    • 获取用户索引
      • 请求示例
      • 请求参数
      • 响应示例
        • 200 OK
    • 通过ID获取单个用户
      • 请求示例
      • 请求参数
      • 响应示例
        • 200 OK
    • 更新用户的显示名称
      • 请求示例
      • 请求参数
      • 响应示例
        • 200 OK
    • (待办：其余端点)
  • 事件
    • 电子邮件更改请求
    • 用户事件

单点登录

工作原理

用户可以在运行此软件包的任何域中登录，只要所有域都连接到同一个usora数据库，并且只需要一次登录尝试。这可以通过在登录成功后使用html img标签在所有参与域上设置认证cookie来实现。

API参考

获取用户索引

GET user/index

请求示例

$.ajax({
    url: 'https://www.musora.com' +
        '/usora/user/index?' +
        'limit=10' + '&' +
        'page=1' + '&' +
        'order_by_column=email' + '&' +
        'order_by_direction=asc',
    type: 'get',
    dataType: 'json',
    success: function(response) {
        // handle success
    },
    error: function(response) {
        // handle error
    }
});

请求参数

响应示例

200 OK

{
   "status":"ok",
   "code":201,
   "results":{
      "id":217988,
      "content_id":202313,
      "key":"difficulty",
      "value":"1",
      "type":"integer",
      "position":1
   }
}

通过ID获取单个用户

GET user/show/{id}

请求示例

var userId = 1;

$.ajax({
    url: 'https://www.musora.com' +
        '/usora/user/show/' . userId,
    type: 'get',
    dataType: 'json',
    success: function(response) {
        // handle success
    },
    error: function(response) {
        // handle error
    }
});

请求参数

响应示例

200 OK

{
   "id":"1",
   "email":"pascale84@schimmel.com",
   "password":"$2y$10$hh5cU.fo.Jq48A267zkjiun\\/W.TwbRs4Pg02Nm.X7k.s5yKQxVMj2",
   "remember_token":"D5mpp6aZhvi5vOD7Fs4EDMw8782Be3hXcrRa7cUEaqt6eXlmQPmKbaU1RKdy",
   "session_salt":"0bPpeEbf13tpNi5zkN6bHSQ5Oq72s7YVrCkh2rkRA65Jttd16d0RGQNJbc1R",
   "display_name":"sed accusamus dolorem ut",
   "created_at":"1526460917",
   "updated_at":"1526460917",
   "fields":[]
}

更新用户的显示名称

PUT user/update/{id}

请求示例

var userId = 1;
var displayNameToSet = 'sed accusamus dolorem ut';

$.ajax({
    url: 'https://www.musora.com' +
        '/usora/user/update/' . userId,
    type: 'patch',
    data: {display_name: displayNameToSet},
    dataType: 'json',
    success: function(response) {
        // handle success
    },
    error: function(response) {
        // handle error
    }
});

请求参数

响应示例

200 OK

{
   "id":"1",
   "email":"pascale84@schimmel.com",
   "password":"$2y$10$hh5cU.fo.Jq48A267zkjiun\\/W.TwbRs4Pg02Nm.X7k.s5yKQxVMj2",
   "remember_token":"D5mpp6aZhvi5vOD7Fs4EDMw8782Be3hXcrRa7cUEaqt6eXlmQPmKbaU1RKdy",
   "session_salt":"0bPpeEbf13tpNi5zkN6bHSQ5Oq72s7YVrCkh2rkRA65Jttd16d0RGQNJbc1R",
   "display_name":"sed accusamus dolorem ut",
   "created_at":"1526460917",
   "updated_at":"1526460917",
   "fields":[

   ]
}

(待办：其余端点)

从https://musora.readme.io/v1.0.0/reference的"USORA用户管理系统 - JSON API"部分获取详细信息

• put, user/store
• patch, user/update/:id
• delete, user/delete/:id
• get, user-field/index/:id
• get, user-field/show/:id
• put, user-field/store
• patch, user-field/update/:id
• patch, user-field/update-or-create-by-key
• delete, user-field/delete/:id
• patch, user-field/update-or-create-multiple-by-key

事件

电子邮件更改请求

捕获了电子邮件更改请求。

触发器存在于EmailChangeController的request方法中

没有监听器存在。

用户事件

捕获任何用户账户更改。

触发器存在于：...

1. UserQuery*方法
   1. insertGetId (eventType param value: "created")
   2. update (eventType param value: "updated")
2. 所有三个UserFieldQuery*方法（eventType param value: "field-updated"在每个中）
   1. insertGetId
   2. update
   3. delete

每个的命名空间是Railroad\Usora\Repositories\Queries

没有监听器存在。