RingCentral OAuth Sever-Only Password Flow with Ruby's HTTParty

Question

作为数据仓库项目的一部分，我目前正在尝试为RingCentral编写一个数据提取应用程序，以将CSV转储到AWS。我已经查看了他们的几篇文档，其中概述了如何使用密码流进行身份验证，但根据文档中的示例，似乎缺少一些内容。

在"密码流"下列出的示例中，有一个从未提及的身份验证标头，其中包含的值由作者凭空提取，然后在下面的身份验证步骤中从未提及。我可以验证我的应用程序是否满足范围为"读取调用日志"的专用、仅服务器要求。以下是我的设置屏幕截图：[链接到图片，因为我没有足够的声誉…呃][2]

使用Sandbox凭据和端点进行开发，以下是我迄今为止所尝试的：

url = 'https://platform.devtest.ringcentral.com/restapi/oauth/token'
headers = {'Content-Type'=>'application/x-www-form-urlencoded'}
body = {:grant_type=>"password", :username=>"13133982093", :password=><OUR_SANDBOX_PASSWORD>}
resp = HTTParty.post(url, headers: headers, body: URI.encode_www_form(body))

打印的响应：

#<HTTParty::Response:0x7ff29588a420 parsed_response={"error"=>"invalid_client", "error_description"=>"Invalid client: ", "errors"=>[{"errorCode"=>"OAU-153", "message"=>"Invalid client: ", "parameters"=>[{"parameterName"=>"client_id", "parameterValue"=>""}]}]}, @response=#<Net::HTTPBadRequest 400 Bad Request readbody=true>, @headers={"server"=>["nginx/1.10.2"], "date"=>["Tue, 20 Jun 2017 22:05:36 GMT"], "content-type"=>["application/json;charset=utf-8"], "transfer-encoding"=>["chunked"], "connection"=>["close"], "x-application-context"=>["application:8080"], "content-language"=>["en"], "www-authenticate"=>["Bearer realm="RingCentral REST API", error="invalid_client", error_description="Invalid client: ""], "rcrequestid"=>["96aaacb0-5604-11e7-97a9-005056bb594d"], "aceroutingkey"=>["sjc11-c01-ace01.c83d65c2-46d3-11e7-ab8e-005056a73f60"], "x-server-name"=>["sjc06-c01-hlb02"], "x-request-time"=>["0.010"], "x-upstream-server"=>["10.24.22.193:8080"], "x-upstream-status"=>["400"], "x-upstream-htime"=>["0.010"], "x-upstream-rtime"=>["1497996336.573"], "x-upstream-ctime"=>["0.000"], "x-tcpinfo"=>["1000, 500, 10, 28960"], "routingkey"=>["SJC11P01"]}> 

我尝试过谷歌搜索错误代码OAU-153，但它完全没有记录。我甚至包括了一些东西，比如从client_id和client_secret(也称为-app_key和app_secret)生成的Authorization Header，比如：auth= {'Authorization': "Basic #{ Base64.encode64("#{client_id}:#{client_secret}") }"}

它包含在一个呼叫中，如：resp = HTTParty.post(token_url, headers: headers, body: URI.encode_www_form(token_body), auth: auth)

但这仍然产生了与上面相同的错误，错误描述为"Invalid Client: "，错误代码为OAU-153。

此外，由于项目需求，Ring Central Ruby SDK会导致与我当前应用程序中非常重要的gem之间的依赖冲突，因此我们必须为此数据源编写新的Auth代码。

在这一点上，我迷失了方向。我已经充分验证了我的密钥、用户名和密码都是正确的。我已经包含了username电话号码值作为格式化的健全性检查。我基本上只剩下两个我无法回答的问题：

1) 我这样做对吗？我是否为此应用程序选择了正确的角色和权限？我需要创建一个具有不同身份验证流和隐私设置的新身份验证流吗？

2) 我用的工具对吗？HTTParty可能是发送我请求的罪魁祸首吗？在我花的时间里，在知识库中挖掘并没有带来太多的启示。

编辑：

我们对项目进行了更改，允许我们使用SDK进行身份验证，如下所示：

client = RingCentralSdk::REST::Client.new do | config |
config.app_key = ENV['RC_CLIENT_ID']
config.app_secret = ENV['RC_CLIENT_SECRET']
config.server_url = @server_url
config.username = @account_num
config.password = @password
config.extension = @extension_id

然后，我们通过执行以下操作将令牌信息存储为哈希：token_hash = client.token.to_hash

散列的一个例子如下：

{"token_type"=>"bearer", "refresh_token_expires_in"=>604800, 
"scope"=>"ReadCallLog", "owner_id"=>[COMPANY's OWNER_ID], 
"endpoint_id"=>"N0UV835BQ2C_Bz2ofJA1Eg", 
:access_token=> [REMOVED FOR SECURITY],
:refresh_token=> [REMOVED FOR SECURITY], 
:expires_at=>1498081681} 

但是，现在我无法执行两个操作：一个简单的身份验证请求或一个令牌刷新。

正在尝试简单的call-log请求：

uri = "https://platform.devtest.ringcentral.com/restapi/v1.0/account/<phone_num_with_pre_+>/extension/101/call-log"
headers = {"Accept"=>"application/json", "Authorization"=> "#{ token_hash[:access_token] }"} 
resp = HTTParty.get(uri, headers: headers)

这种请求给我带来了一个错误：

#<HTTParty::Response:0x7fdf2b0ae800 parsed_response={"errorCode"=>"InvalidParameter", "message"=>"Resource for parameter [accountId] is not found", "errors"=>[{"errorCode"=>"CMN-102", "message"=>"Resource for parameter [accountId] is not found", "parameterName"=>"accountId"}], "parameterName"=>"accountId"}, @response=#<Net::HTTPNotFound 404 Not Found readbody=true>, @headers={"server"=>["nginx/1.10.2"], "date"=>["Wed, 21 Jun 2017 21:39:58 GMT"], "content-type"=>["application/json;charset=UTF-8"], "content-length"=>["290"], "connection"=>["close"], "rcrequestid"=>["2b66c9d6-56ca-11e7-b418-005056bb26b9"], "routingkey"=>["SJC11P01PAS02"], "x-error-id"=>["2b66c9d6-56ca-11e7-b418-005056bb26b9"], "content-language"=>["en-US"], "x-rate-limit-group"=>["heavy"], "x-rate-limit-limit"=>["10"], "x-rate-limit-remaining"=>["9"], "x-rate-limit-window"=>["60"]}>

这个错误表明了两件事：1)我的account_id参数输入错误——但是，我直接从RC开发人员门户为我的应用程序复制了Sandbox编号，无论是带前缀的+还是不带前缀的，都发生了相同的错误；2)没有call-log记录，因此API服务器认为Resource不存在并抛出了错误。

所以，我想我的问题是？当没有数据可供我查询时，我怎么能针对这个沙盒进行开发？有没有一种简单的方法可以为这个帐户制作数据？

正在尝试刷新令牌流：

注意：我只是在每次需要代币时再次登录。笨拙但并不可怕。

执行请求：

uri = "https://platform.devtest.ringcentral.com/restapi/oauth/token"
refresh_headers = {"Accept"=>"application/json", "Content-Type"=>"application/x-www-form-urlencoded", 
"Authentication"=>"Basic [BASE64_ENCODED_APP_KEY:APP_SECRET_DELIMITED_COMBO]}
refresh_body = {:grant_type=>"refresh_token", :refresh_token=>"#{token_hash[:refresh_token]}"} 
resp = HTTParty.post(uri, headers: refresh_headers, body: URI.www_encode_form(refresh_body))

赚取错误：

#<HTTParty::Response:0x7fdf3055d8d8 parsed_response={"error"=>"invalid_client", "error_description"=>"Invalid client: ", "errors"=>[{"errorCode"=>"OAU-153", "message"=>"Invalid client: ", "parameters"=>[{"parameterName"=>"client_id", "parameterValue"=>""}]}]}, @response=#<Net::HTTPBadRequest 400 Bad Request readbody=true>, @headers={"server"=>["nginx/1.10.2"], "date"=>["Wed, 21 Jun 2017 22:16:07 GMT"], "content-type"=>["application/json;charset=utf-8"], "transfer-encoding"=>["chunked"], "connection"=>["close"], "x-application-context"=>["application:8080"], "content-language"=>["en"], "www-authenticate"=>["Bearer realm="RingCentral REST API", error="invalid_client", error_description="Invalid client: ""], "rcrequestid"=>["3958edb2-56cf-11e7-8758-005056bb26b9"], "aceroutingkey"=>["sjc11-c01-ace01.c83d65c2-46d3-11e7-ab8e-005056a73f60"], "x-server-name"=>["sjc06-c01-hlb01"], "x-request-time"=>["0.000"], "x-upstream-server"=>["10.24.22.193:8080"], "x-upstream-status"=>["400"], "x-upstream-htime"=>["0.000"], "x-upstream-rtime"=>["1498083367.846"], "x-upstream-ctime"=>["0.000"], "x-tcpinfo"=>["1000, 500, 10, 28960"], "routingkey"=>["SJC11P01"]}> 

默默地为自己哭泣。。。

:'-(

令人沮丧的是，RingCentralRubySDK的文档中没有刷新这些令牌的方法，并且含糊地提到了一些关于"手动刷新"的内容。如果您对我的请求或SDK有任何想法或想法，我们将不胜感激。我更愿意执行刷新，而不是一次又一次地重新验证。

Answer 1

令人沮丧的是，RingCentral Ruby SDK的文档中没有记录刷新这些令牌的方法，并含糊地提到了一些关于"手动刷新"的内容。如果您对我的请求或SDK有任何想法或想法，我们将不胜感激。我更愿意执行刷新，而不是一次又一次地重新验证。

代币刷新在repo的/docs文件夹中的详细文档中，也发布在Ruby SDK的Read the Docs上。我会让这些文件更加明显。

文档的令牌刷新部分在这里可用：

http://ringcentral-sdk-ruby.readthedocs.io/en/latest/usage/authorization/Authorization/#token-刷新

关于调用日志请求，您可以通过下面的API调用直接使用SDK进行调用。

client = RingCentralSdk::REST::Client.new do | config |
# ...
end
client.http.get 'account/~/extension/~/call-log'

对于accountId和extensionId路径参数，可以使用~指示当前登录用户的帐户和扩展名。如果要指定accountId和extensionId，请注意，它们是后端id值，与用户拨打的主要公司电话号码或extensionNumber不对应。您可以通过调用account/~/extensionAPI端点来检索登录用户的accountId和extensionId。