Docebo - 构建授权头 [英] Docebo - constructing authorisation header

问题描述

我一直在试图构建Docebo授权头，但我无法得到它的工作，如文档是不够的描述和code样品（仅code样品）是非常混乱的。

I have been trying to construct authorisation header for Docebo but I am unable to get it working as the documentation is not descriptive enough and their code sample (only code sample) is very confusing.

这是基本上所有 Docebo文档：

我所试图做的是让所有用户的列表。

What I am trying to do is to get a list of all users.

public JsonResult GetCoursesCount()
        {
            const string apiKey = "[API KEY FROM MY DOCEBO PORTAL]";
            const string apiSecret = "[API SECRET FROM MY DOCEBO PORTAL]";
            const string doceboUrl = "[URL OF MY DOCEBO PORTAL]";

            using (var httpClient = new HttpClient())
            {
                httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                var toEncodeWithSha1 = String.Format("{0},{1}", String.Join(",", new[] {"0", "null"}), apiSecret); // should the values be values or parameters??

                var code = GetSHA1HashData(toEncodeWithSha1);

                var toEncodeWithBase64 = String.Format("{0}:{1}", apiKey, code);

                code = Base64Encode(toEncodeWithBase64);

                var xAuthorisation = String.Format("Docebo {0}", code);

                httpClient.DefaultRequestHeaders.Add("X-Authorization", xAuthorisation);

                var stringContent = JsonConvert.SerializeObject("{ \"from\": \"0\", \"count\": \"null\" }");

                var userResult = httpClient.PostAsync(String.Format("{0}/api/user/listUsers", doceboUrl),
                    new StringContent(stringContent)).Result;

                var userData = JsonConvert.DeserializeObject<dynamic>(userResult.Content.ReadAsStringAsync().Result);

                return new JsonResult { Data = userData, JsonRequestBehavior = JsonRequestBehavior.AllowGet };
            }
        }

private string GetSHA1HashData(string data)
        {
            //create new instance of md5
            var sha1 = SHA1.Create();

            //convert the input text to array of bytes
            byte[] hashData = sha1.ComputeHash(Encoding.Default.GetBytes(data));

            //create new instance of StringBuilder to save hashed data
            var returnValue = new StringBuilder();

            //loop for each byte and add it to StringBuilder
            foreach (byte @byte in hashData)
            {
                returnValue.Append(@byte.ToString());
            }

            // return hexadecimal string
            return returnValue.ToString();
        }

        private string Base64Encode(string plainText)
        {
            var plainTextBytes = Encoding.UTF8.GetBytes(plainText);
            return Convert.ToBase64String(plainTextBytes);
        }

每当我与他们的API，我得到{
  成功：假的，
  消息：授权头值不匹配
  code：104
}。

Anytime I contact their API I get "{ "success": false, "message": "Authorization header value doesn't match", "code": 104 }".

这将是伟大获得在这个或反馈他们的API文档的可理解的翻译。

It would be great to get a feedback on this or an understandable translation of their API documentation.

推荐答案

长期的斗争（8小时）后，我决定正确的code。

After long struggle (8 hours) I resolved the correct code.

public JsonResult GetCoursesCount()
        {
            const string apiKey = "[API KEY FROM MY DOCEBO PORTAL]";
            const string apiSecret = "[API SECRET FROM MY DOCEBO PORTAL]";
            const string doceboUrl = "[URL OF MY DOCEBO PORTAL]";

            using (var httpClient = new HttpClient())
            {
                httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                var listKeyValuePair = new List<KeyValuePair<string,string>>
                {
                    new KeyValuePair<string, string>("from", "0"), 
                    new KeyValuePair<string, string>("count", "10")
                };

                var toEncodeWithSha1 = String.Format("{0},{1}", String.Join(",", listKeyValuePair.Select(n => n.Value)), apiSecret); // should the values be values or parameters??

                var code = Sha1Hash(toEncodeWithSha1);

                var toEncodeWithBase64 = String.Format("{0}:{1}", apiKey, code);

                code = Base64Encode(toEncodeWithBase64);

                var xAuthorisation = String.Format("Docebo {0}", code);

                httpClient.DefaultRequestHeaders.Add("X-Authorization", xAuthorisation);

                var content = new FormUrlEncodedContent(listKeyValuePair);

                var userResult = httpClient.PostAsync(String.Format("{0}/api/user/listUsers", doceboUrl),
                    content).Result;

                var responseByteArray = userResult.Content.ReadAsByteArrayAsync().Result;

                var convertedResult = Encoding.UTF8.GetString(responseByteArray, 0, responseByteArray.Length);

                var userData = JsonConvert.DeserializeObject<UserListResult>(convertedResult);

                return new JsonResult { Data = userData, JsonRequestBehavior = JsonRequestBehavior.AllowGet };
            }
        }

        public class UserListResult
        {
            public List<dynamic> Users { get; set; }
            public bool Success { get; set; }
        }

        private string Sha1Hash(string input)
        {
            return string.Join(string.Empty, SHA1.Create().ComputeHash(Encoding.UTF8.GetBytes(input)).Select(x => x.ToString("x2")));
        }

        private string Base64Encode(string plainText)
        {
            var plainTextBytes = Encoding.UTF8.GetBytes(plainText);
            return Convert.ToBase64String(plainTextBytes);
        }

包括参考PHP的例子：

Including the PHP example for reference:

<?php
/**
* DOCEBO, e-learning SAAS
*
* @link http://www.docebo.com/
* @copyright Copyright &copy; 2004-2013 Docebo
*/
class Api {
static public $url = 'yoursite.docebosaas.com';
static public $key = 'your_key_from_api_app';
static public $secret_key = 'your_secret_from_api_app';
static public $sso = 'your_toekn_from_api_app';
static public function getHash($params) {
$res =array('sha1'=>'', 'x_auth'=>'');
$res['sha1']=sha1(implode(',', $params) . ',' . self::$secret_key);
$res['x_auth']=base64_encode(self::$key . ':' . $res['sha1']);
return $res;
}
static private function getDefaultHeader($x_auth) {
return array(
"Host: " . self::$url,
"Content-Type: multipart/form-data",
'X-Authorization: Docebo '.$x_auth,
);
}
static public function call($action, $data_params) {
$curl = curl_init();
$hash_info = self::getHash($data_params);
$http_header =self::getDefaultHeader($hash_info['x_auth']);
$opt = array(
CURLOPT_URL=>self::$url . '/api/' . $action,
CURLOPT_RETURNTRANSFER=>1,
CURLOPT_HTTPHEADER=>$http_header,
CURLOPT_POST=>1,
CURLOPT_POSTFIELDS=>$data_params,
CURLOPT_CONNECTTIMEOUT=>5, // Timeout to 5 seconds
);
curl_setopt_array($curl, $opt);
// $output contains the output string
$output = curl_exec($curl);
// it closes the session
curl_close($curl);
return $output;}
static public function sso($user) {
$time = time();
$token = md5($user.','.$time.','.self::$sso);
return 'http://' . self::$url .
'/doceboLms/index.php?modname=login&op=confirm&login_user=' . strtolower($user) . '&time=' .
$time . '&token=' . $token;
}
}
// sample call
$res = API::call('user/checkUsername', array(
'userid' => 'username_to_chek'
));

这篇关于Docebo - 构建授权头的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！