用于gameworks服务的python rest sdk
gameworks的Python项目详细描述
简介
为Gameworks应用程序和服务提供服务的软件开发工具包。sdk目前允许您连接到gameworks注册表api。
功能
- 能够通过基本身份验证令牌连接到Gameworks服务
- 能够连接到注册表API服务:
- 用户注册
- 创建玩家配置文件
- 创建发布者配置文件
未来版本
- 将能够通过Gameworks出纳API创建NEM区块链交易
- 将能够通过OAuth 2.0协议连接到Gameworks服务
安装
要安装Gameworks SDK(稳定版本),请在终端中运行此命令:
$ pip install gameworks
开发
代码托管在gameworks python sdk git repository上
$ git clone git://github.com/gameworks-gwx/gameworks-python-sdk.git
$ cd gameworks-python-sdk
设置虚拟环境以隔离python依赖项。
$ virtualenv venv
$ source venv/bin/activate
安装开发依赖项。
$ pip install -r requirements-dev.txt #optional
运行测试。
$ python -m unittest
配置
要开始,请导入Gameworks SDK Python模块。
importgameworks
在respository中创建一个.env文件来设置环境变量。在此上下文中,.env文件用于配置两个环境变量:用于访问要连接到的apigameworks\u key
的授权密钥和api environmentgameworks\u env
。为sdk提供了两个环境,分别是sandbox
和live
;默认情况下,sdk指向sandbox环境。沙盒环境用作开发目的的游乐场,而实时环境则连接到实际的注册表api。
$ touch .env $ sudo nano .env
.env
exportGAMEWORKS_KEY="Authentication Token"exportGAMEWORKS_ENV="live"#sandbox or live
然后,使用source执行.env文件中的命令
$ source .env
用法
会话模块
此模块允许您配置认证变量,注册用户帐户,使用现有用户帐户登录。您可以选择使用Gameworks凭据登录注册表API,或使用以前登录时提供给您的现有JWT访问令牌。
注册用户帐户
创建用户时,请使用Gameworks Mobile Wallet提供的电子钱包地址或NEM电子钱包地址。
$ pip install gameworks0
请注意,所有结果都将作为响应对象返回。您可以参考请求包响应对象
使用用户帐户登录
使用用户帐户登录将触发创建另一个令牌。令牌在创建后一小时内到期。
$ pip install gameworks1
存储令牌
如果您已经有了访问令牌,您可以选择绕过登录过程,直接使用Gameworks服务的功能。在alpha版本中,作为环境变量导出的令牌正在使用BLE,因此无需使用此功能进行身份验证。
$ pip install gameworks2
注册表模块
此模块允许您创建、更新和查看一个用户帐户、一个播放器配置文件和一个发布者帐户。此模块中包含的所有函数都可以由令牌/密钥提供。您可以将它们添加到参数中,以便手动激活功能,而无需创建.env文件。请参见下面的代码作为示例:
$ pip install gameworks3
用户资源功能
查找用户
*需要身份验证令牌
要检索用户的帐户详细信息,您可以选择使用下面的代码进行查询:
$ pip install gameworks4
更新用户
*需要身份验证令牌
您可以选择更新帐户信息中的特定数据。您不需要填写帐户信息中的所有参数。可更新的账户参数包括:firstname
,lastname
,wallet address
和pk
(与NEM钱包地址关联的私钥)
$ pip install gameworks5
确认用户
注册用户帐户并登录后,您将在提供的电子邮件中收到包含确认代码的消息。使用下面的代码以编程方式确认您的帐户。您不再需要输入用户ID,因为注册表API已经知道代码分配给哪个帐户。
$ pip install gameworks6
重新发送代码
*需要身份验证令牌
如果您的确认码尚未通过电子邮件发送,您可以选择使用下面的代码重新发送确认码:
$ pip install gameworks7
播放器配置文件资源功能
注册播放器配置文件
*需要身份验证令牌
通过输入所需的用户名
和用户名
来创建播放器配置文件,如下所示:
$ pip install gameworks8
查找播放器配置文件
*需要身份验证令牌
要检索您的播放器配置文件,请使用以下代码进行查询:
$ pip install gameworks9
更新播放器配置文件
*需要身份验证令牌
通过执行下面的代码更新您的用户名:
$ git clone git://github.com/gameworks-gwx/gameworks-python-sdk.git
$ cd gameworks-python-sdk
0
发布者帐户资源功能
注册发布者帐户
*需要身份验证令牌
通过执行以下代码创建发布者帐户:
$ pip install gameworks8
查找发布者配置文件
*需要身份验证令牌
要检索您的发布者配置文件,请使用下面的代码进行查询:
$ git clone git://github.com/gameworks-gwx/gameworks-python-sdk.git
$ cd gameworks-python-sdk
2
更新发布者配置文件
*需要身份验证令牌
您可以选择更新发布者帐户信息中的特定数据。您不需要填写帐户信息中的所有参数。可更新的帐户参数包括:userid
,wallet address
(电子钱包地址可能与用户帐户的电子钱包地址不同),publishername
,description
$ git clone git://github.com/gameworks-gwx/gameworks-python-sdk.git
$ cd gameworks-python-sdk
3
许可证
$ git clone git://github.com/gameworks-gwx/gameworks-python-sdk.git
$ cd gameworks-python-sdk
4
其他
享受我们的平台?让我们在github上留下一颗星星来激励我们为您创造更多的服务。