如何使用 Canvas Data REST API 使用 python？

Question

我工作的组织开始使用 Canvas LMS，我负责提取平台的数据，以帮助进行数据洞察。

Canvas LMS 提供数据 API 很棒，但我很难找到要使用的 Python 包装器。我想使用 Python 与它进行交互，这是我们官方堆栈的一部分。

我知道(https://portal.inshosteddata.com/docs/api)中有官方文档，但我并没有真正使用授权方法，如果有它会容易得多示例代码。

那么，我应该如何启动我的 python 代码来与 Canvas LMS 数据交互 API？

Answer 1

我们开始了！

在 Canvas 社区的帮助下，我终于通过他们的网站 (https://community.canvaslms.com/thread/7423) 完成了它。我也在这里发布问题和答案，因为我相信 Whosebug 更容易找到答案。

希望这对其他人有用！

#!/usr/bin/python

#imports
import datetime
import requests
import hashlib
import hmac
import base64
import json


#Get the current time, printed in the right format
def nowAsStr():
  currentTime = datetime.datetime.utcnow()
  prettyTime = currentTime.strftime('%a, %d %b %Y %H:%M:%S GMT')
  return prettyTime

#Set up the request pieces
apiKey = 'your_key'
apiSecret = 'your_secret'
method = 'GET'
host = 'api.inshosteddata.com'
path = '/api/account/self/dump'
timestamp = nowAsStr()

requestParts = [
  method,
  host,
  '', #content Type Header
  '', #content MD5 Header
  path,
  '', #alpha-sorted Query Params
  timestamp,
  apiSecret
]

#Build the request
requestMessage = '\n'.join(requestParts)
print (requestMessage.__repr__())
hmacObject = hmac.new(apiSecret, '', hashlib.sha256)
hmacObject.update(requestMessage)
hmac_digest = hmacObject.digest()
sig = base64.b64encode(hmac_digest)
headerDict = {
  'Authorization' : 'HMACAuth ' + apiKey + ':' + sig,
  'Date' : timestamp
}

#Submit the request/get a response
uri = "https://"+host+path
print (uri)
print (headerDict)
response = requests.request(method='GET', url=uri, headers=headerDict, stream=True)

#Check to make sure the request was ok
if(response.status_code != 200):
  print ('Request response went bad. Got back a ', response.status_code, ' code, meaning the request was ', response.reason)
else:
  #Use the downloaded data
  jsonData = response.json()
  print json.dumps(jsonData, indent=4)

如何使用 Canvas Data REST API 使用 python？

How can I use Canvas Data REST API using python?

python

canvas-lms