• 多说评论系统API调用和本地身份说明(JWT)


    多说评论系统是一个非常好用的第三方评论插件,聚合了大多数的SNS平台账号登录和分享功能,UI也很不错。

    作为网站快速接入评论系统,多说是一个比较好的选择,其也提供了一些实用的API去满足定制化需求。

    多说API支持将本地的用户基本信息同步到多说服务器,实现了本地用户系统和多说用户验证机制的一致。

    大概的过程:在用户注册或者修改个人信息的时候将用户信息同步至多说服务器,并在用户登录后在本地cookie写入JWT值,多说可以进行判断而实现用户无需再登录多说系统就可以进行评论。

    Array参数注意点

    在使用多说同步用户信息API时,用户的信息users参数的类型为array,这里需要特别注意其格式处理。

    不过还是推荐多说团队使用json作为参数格式或者使用新浪微博的处理方式:参数类型为string,多个参数使用逗号分隔,开发者的处理成本会小很多。

    具体的参数格式为:users[0][user_key]=1&users[0][name]=parry&....

    这个具体的正确格式尝试了很多种方式后,在看到原始的ASP处理方式时才知道,谢谢多说技术人员小武的耐心解答(QQ:1175762238)。

    他给的asp源码在这里

    两个辅助函数

    顺手整理出了两个方法:POST数据到多说的API接口和设置多说本地身份说明(JWT)。

    注意:在POST数据到多说的API接口方法中只处理了一个arrayPostData的情况,多个数组的形式请自行修改。

    项目名称就叫DuoShuo.SDK.Partial了,希望更多的人来完善SDK。

    有可以优化的地方请多指教。

      1 using System;
      2 using System.Collections.Generic;
      3 using System.IO;
      4 using System.Linq;
      5 using System.Net;
      6 using System.Web;
      7 
      8 namespace DuoShuo.SDK.Partial
      9 {
     10     /// <summary>
     11     /// 多说POST请求的帮助类,主要解释了array参数的拼接格式和JWT的设置
     12     /// </summary>
     13     /// <author>
     14     /// Parry
     15     /// Mail: qiupengyuan@gmail.com
     16     /// Blog: http://www.cnblogs.com/parry
     17     /// </author>
     18     public class DuoShuoHelper
     19     {
     20         #region POST数据
     21 
     22         /// <summary>
     23         /// POST数据到多说的API接口
     24         /// </summary>
     25         /// <summary>http://dev.duoshuo.com/docs/51435552047fe92f490225de</summary>
     26         /// <param name="apiUrl">接口的URL,如http://api.duoshuo.com/users/import.json</param>
     27         /// <param name="prePostData">不包含array参数的前置数据,类似:short_name=当前站点注册的多说二级域名&secret=站点多说密钥</param>
     28         /// <param name="arrayName">array形式的参数的名称,如users</param>
     29         /// <param name="arrayPostData">array形式的参数数据</param>
     30         /// <returns>接口返回的字符串</returns>
     31         /// <example>
     32         /// 注意array参数,在.NET下可以使用HashTable或者Dictionary实现
     33         /// 如:
     34         /// Dictionary<string, object> arrayPostData = new Dictionary<string, object>();
     35         /// arrayPostData.Add("user_key", 1);
     36         /// arrayPostData.Add("name", "Parry");
     37         /// arrayPostData.Add("role", "user");
     38         /// arrayPostData.Add("avatar_url", "");
     39         /// arrayPostData.Add("url", "");
     40         /// arrayPostData.Add("email", "");
     41         /// arrayPostData.Add("created_at", DateTime.Now.ToString("yyyy-mm-dd hh:MM:ss"));
     42         /// </example>
     43         /// <remarks>注意:此方法只处理了一个arrayPostData的情况,多个数组的形式请自行修改</remarks>
     44         public string HttpPostData(string apiUrl, string prePostData, string arrayName, Dictionary<string, object> arrayPostData)
     45         {
     46             var webRequest = WebRequest.Create(apiUrl) as HttpWebRequest;
     47             if (webRequest != null)
     48             {
     49                 webRequest.Method = "post";
     50                 webRequest.ContentType = "application/x-www-form-urlencoded";
     51 
     52                 //postData赋值
     53                 var postData = prePostData + "&" + string.Join("&", arrayPostData.Select(keyValuePair => string.Format("{0}[0][{1}]={2}", arrayName, keyValuePair.Key, keyValuePair.Value)).ToArray());
     54 
     55                 ////使用非LINQ实现postData赋值
     56                 //var listJoinArrayParamemter = new List<string>();
     57                 //foreach (KeyValuePair<string, object> keyValuePair in arrayPostData)
     58                 //{
     59                 //    listJoinArrayParamemter.Add(string.Format("users[0][{0}]={1}", keyValuePair.Key, keyValuePair.Value));
     60                 //}
     61                 //var postData = prePostData + "&" + string.Join("&", listJoinArrayParamemter.ToArray());
     62 
     63                 using (var sw = new StreamWriter(webRequest.GetRequestStream()))
     64                 {
     65                     sw.Write(postData);
     66                 }
     67 
     68                 using (var response = webRequest.GetResponse())
     69                 {
     70                     var stream = response.GetResponseStream();
     71                     if (stream == null) return string.Empty;
     72                     using (var sr = new StreamReader(stream))
     73                     {
     74                         return sr.ReadToEnd();
     75                     }
     76                 }
     77             }
     78             return string.Empty;
     79         }
     80 
     81         #endregion
     82 
     83         #region 多说本地身份说明(JWT)
     84 
     85         /// <summary>
     86         /// 设置多说本地身份说明(JWT)
     87         /// </summary>
     88         /// <summary>http://dev.duoshuo.com/docs/501e6ce1cff715f71800000d</summary>
     89         /// <param name="secretKey">站点多说密钥</param>
     90         /// <param name="shortName">当前站点注册的多说二级域名</param>
     91         /// <param name="userKey">用户在当前站点中对应的唯一标示,通常是用户ID</param>
     92         /// <param name="name">用户在当前网站的用户名</param>
     93         public void SetLocalJwt(string secretKey, string shortName, string userKey, string name)
     94         {
     95             var array = new Dictionary<string, object>
     96             {
     97                 {"short_name", shortName},
     98                 {"user_key", userKey},
     99                 {"name", name}
    100             };
    101             string token = JsonWebToken.Encode(array, secretKey, JwtHashAlgorithm.HS256);
    102             //cookie设置了一年过期
    103             var cookie = new HttpCookie("duoshuo_token") { Value = token, Expires = DateTime.Now.AddDays(365) };
    104             HttpContext.Current.Response.Cookies.Add(cookie);
    105         }
    106 
    107         #endregion
    108 
    109     }
    110 }

    完整源码下载,包含JWT公共类。

  • 相关阅读:
    Ado.Net Entity Framework 批量删除、判断存在
    Asp.Net MVC 3 与 HTML 5
    Entity SQL 时间条件比较
    Visual Studio 2010 调试 C 语言程序
    XAML 属性设置Windows Phone笔记
    SQL Server 2008 R2 数据库之间的数据同步热备份
    SQL Server 2008 R2 SP1正式版发布
    一个 Windows Form Demo
    PL SQL 9 安装 并连接 64位 Oracle 11G
    转载:如何稳定地使用 Google 搜索
  • 原文地址:https://www.cnblogs.com/parry/p/duoshuo_sdk_partial.html
Copyright © 2020-2023  润新知