使用令牌对API进行身份验证

时间:2013-08-16 08:27:50

标签: ruby-on-rails api http authorization httprequest

我正在使用Zendesk API,这是一个仅限HTTPS的JSON API,需要身份验证来更新资源,并且API提供了一个API令牌,以便在作为不同用户进行身份验证时使用。更新资源时,我通过SSL发出PUT请求,将相应的JSON内容分配给请求正文,并将Content-Type请求标头指定为application/json

接下来,API指示其用户通过使用用户的电子邮件和密码(由于多种原因无法做到)或使用用户的电子邮件地址以及API令牌来作为最终用户进行身份验证。以下是我尝试使用Authorization标头授权API:

@id = params[:id]
@comment_body = params[:comment]

uri = URI.parse "https://{subdomain}.zendesk.com/api/v2/requests/#{@id}.json"
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
req = Net::HTTP::Put.new(uri.request_uri)
req.body = '{"request": {"comment":{"value":' + "\"#{@comment_body}\"" + '}}}'
req['Content-Type'] = 'application/json'

#The following two lines do not work!
credentials = Base64::encode64("{user_email}/token:{api_token}")
request.headers['Authorization'] = "Basic #{credentials}"

response = http.request(req)

API指定使用API​​令牌进行身份验证的格式为{user_email}/token:{api_token}。我使用Base64::encode64对该格式进行了编码,并将其传递给Basic之前的授权标头,但响应是401 Unauthorized。但是,用req.basic_auth {user_email}, {user_password}替换这两行可以正常工作。

所以我的问题是,如何使用电子邮件和给定的API令牌作为身份验证,而不是将用户的电子邮件和密码提供给req.basic_auth,作为不同的用户进行身份验证?

我在这个主题上所做的谷歌搜索显示很少;显然,在处理Authorization标头时使用普通{username}:{password}格式比使用API​​令牌更常见。

提前致谢!!

更新:奇怪的是,在尝试授权为{{1}时,尝试以req['Authorization'] = "Basic #{credentials}"作为最终用户进行身份验证时,不会返回401 Unauthorized Error或WWW-Authenticate标头确实。

1 个答案:

答案 0 :(得分:3)

经过多次头撞,几乎把我的笔记本电脑扔到了窗外,终于弄明白了。突然间,答案似乎非常明显。

使用Net :: HTTP时,其basic_auth方法也可以接受令牌,具体取决于API,Zendesk API指定使用API​​令牌的格式为{email} / token:{token}。基本身份验证使用格式{username}:{password},其中这两个字段用冒号分隔,这意味着在Zendesk的情况下我可以将{email} / token作为第一个参数和{token}作为第二个参数(而不是用户名作为第一个参数,密码作为第二个参数),所以以下代码是正确的:

req.basic_auth "{email}/token", "{api_token}"

我希望任何发现这个有用的人都可以发表评论。很高兴知道我从这个挫折中饶过了一个人。