eleme openapi python sdk
Project description
# Python SDK 接入指南 & CHANGELOG
## 接入指南
1.安装eleme sdk依赖包,引入依赖
2.利用sdk.config 模块初始化设置沙箱环境,key,secret,调用config.set_log 设置自己的log处理方式。如果是企业应用还需设置callback_url
利用sdk.oauth 模块完成oauth授权测试
利用sdk.api 模块完成接口调用测试
启动sdk自带的server 帮助完成接收饿了么推送消息业务,以及授权测试
3.上线前将config.py中初始值__sandbox,key和secret以及callback_url填为正式环境
## 代码示例
### 企业应用
- 第一步 安装sdk 包,引入模块
sudo pip install eleme.python.sdk
```python
from sdk.library.oauth.oauth_client import OAuthClient
from sdk.apis.shop_service import ShopService
from sdk.config import Config
```
- 第二步 实例化一个config 实例化一个oauth2.0客户端授权模式的授权对象
```python
config = Config(True, key, secret, call_back_url)
oauth_client = OAuthClient(config)
```
- 第三步 获取生成授权url
```python
auth_url = oauth_client.get_auth_url(state, scope)
```
- 第四步 在授权url中同意授权后,会跳转到CALLBACK_URL的页面,在通过链接上的参数,获取授权码code
- 第五️步 通过code获取token对象,此步获取到的token对象可在有效期内一直使用,不用每次调用前都去获取一次,建议应用授权一次后存放到全局缓存中
```python
token = oauth_client.get_token_by_code(code)
```
- 第六步 实例化远程调用的client对象
```python
rpc_client = RpcClient(config, token)
```
- 第七步 实例化一个服务对象
```python
shop_service = ShopService(rpc_client)
```
- 第八步 调用服务方法,获取资源数据
```python
shop = shop_service.get_shop(123456)
```
- 第九步 如果token过期,通过refresh_token换取新的token
```python
refresh_token = token["refresh_token"]
token = oauth_client.get_token_by_refresh_token(refresh_token, scope)
```
### 个人应用
- 第一步 安装sdk 包,引入模块
sodu install eleme.openapi.sdk
```python
from sdk.oauth.oauth_client import OAuthClient
from sdk.apis.shop_service import ShopService
from sdk.protocol.rpc_client import RpcClient
from sdk.config import Config
```
- 第二步 实例化config对象,实例化一个oauth2.0客户端授权模式的授权对象
```python
config = Config(True, key, secret)
oauth_client = OAuthClient(config)
```
- 第三️步 获取token对象,此步获取到的token对象可在有效期内一直使用,不用每次调用前都去获取一次,建议应用授权一次后存放到全局缓存中
```python
token = oauth_client.get_token_in_client_credentials()
```
- 第四步 实例化远程调用的client对象
```python
rpc_client = RpcClient(token, config)
```
- 第五步 实例化一个服务对象
```python
shop_service = ShopService(rpc_client)
```
- 第六步 调用服务方法,获取资源数据
```python
shop = shop_service.get_shop(123456)
```
### Server 使用方式
- 第一步 安装sdk 包,引入模块
sodu install eleme.openapi.sdk
- 第二步 引入依赖
```python
from sdk.config import Config
from server.global_config import Global
from server.start_up import boot_start
```
- 第三步 初始化config对象,并将config对象设置到Global中
config = Config(True, key, secret, call_back_url)
Global(config)
启动服务
```python
boot_start(port)
```
启动服务后 会监听三个localtion
1.get /listenMessage 响应饿了么平台的url校检
2.post /listenMessage 接收饿了么平台的消息推送
3.get /callback 授权回调地址,处理授权逻辑
4.post /getInfo 获取当前的用户信息和店铺信息
## CHANGELOG:
### [v1.0.0]
Release Date : 2017-04-07
- [feature] eleme sdk
## 接入指南
1.安装eleme sdk依赖包,引入依赖
2.利用sdk.config 模块初始化设置沙箱环境,key,secret,调用config.set_log 设置自己的log处理方式。如果是企业应用还需设置callback_url
利用sdk.oauth 模块完成oauth授权测试
利用sdk.api 模块完成接口调用测试
启动sdk自带的server 帮助完成接收饿了么推送消息业务,以及授权测试
3.上线前将config.py中初始值__sandbox,key和secret以及callback_url填为正式环境
## 代码示例
### 企业应用
- 第一步 安装sdk 包,引入模块
sudo pip install eleme.python.sdk
```python
from sdk.library.oauth.oauth_client import OAuthClient
from sdk.apis.shop_service import ShopService
from sdk.config import Config
```
- 第二步 实例化一个config 实例化一个oauth2.0客户端授权模式的授权对象
```python
config = Config(True, key, secret, call_back_url)
oauth_client = OAuthClient(config)
```
- 第三步 获取生成授权url
```python
auth_url = oauth_client.get_auth_url(state, scope)
```
- 第四步 在授权url中同意授权后,会跳转到CALLBACK_URL的页面,在通过链接上的参数,获取授权码code
- 第五️步 通过code获取token对象,此步获取到的token对象可在有效期内一直使用,不用每次调用前都去获取一次,建议应用授权一次后存放到全局缓存中
```python
token = oauth_client.get_token_by_code(code)
```
- 第六步 实例化远程调用的client对象
```python
rpc_client = RpcClient(config, token)
```
- 第七步 实例化一个服务对象
```python
shop_service = ShopService(rpc_client)
```
- 第八步 调用服务方法,获取资源数据
```python
shop = shop_service.get_shop(123456)
```
- 第九步 如果token过期,通过refresh_token换取新的token
```python
refresh_token = token["refresh_token"]
token = oauth_client.get_token_by_refresh_token(refresh_token, scope)
```
### 个人应用
- 第一步 安装sdk 包,引入模块
sodu install eleme.openapi.sdk
```python
from sdk.oauth.oauth_client import OAuthClient
from sdk.apis.shop_service import ShopService
from sdk.protocol.rpc_client import RpcClient
from sdk.config import Config
```
- 第二步 实例化config对象,实例化一个oauth2.0客户端授权模式的授权对象
```python
config = Config(True, key, secret)
oauth_client = OAuthClient(config)
```
- 第三️步 获取token对象,此步获取到的token对象可在有效期内一直使用,不用每次调用前都去获取一次,建议应用授权一次后存放到全局缓存中
```python
token = oauth_client.get_token_in_client_credentials()
```
- 第四步 实例化远程调用的client对象
```python
rpc_client = RpcClient(token, config)
```
- 第五步 实例化一个服务对象
```python
shop_service = ShopService(rpc_client)
```
- 第六步 调用服务方法,获取资源数据
```python
shop = shop_service.get_shop(123456)
```
### Server 使用方式
- 第一步 安装sdk 包,引入模块
sodu install eleme.openapi.sdk
- 第二步 引入依赖
```python
from sdk.config import Config
from server.global_config import Global
from server.start_up import boot_start
```
- 第三步 初始化config对象,并将config对象设置到Global中
config = Config(True, key, secret, call_back_url)
Global(config)
启动服务
```python
boot_start(port)
```
启动服务后 会监听三个localtion
1.get /listenMessage 响应饿了么平台的url校检
2.post /listenMessage 接收饿了么平台的消息推送
3.get /callback 授权回调地址,处理授权逻辑
4.post /getInfo 获取当前的用户信息和店铺信息
## CHANGELOG:
### [v1.0.0]
Release Date : 2017-04-07
- [feature] eleme sdk
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for eleme.openapi.python.sdk-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddade4fa8500b8c97ddf3ceecc439f0af22e3a7ff424573bc3bbc67f7e7a4ffa |
|
MD5 | de8907b10f9c6f7120bf6e6289a7dd86 |
|
BLAKE2b-256 | 1d4b5feaa7c1ec149bdb5b23674f0b4e9dd3860bb171db57b2802ada5acd7f28 |
Close
Hashes for eleme.openapi.python.sdk-0.0.1-py2.7.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | adc249a47f68312d7846d34774157c588c72ea888b9c83d34c6a67da504640ee |
|
MD5 | d7fc3d1e68a9361754032c380f7b53fb |
|
BLAKE2b-256 | 144ef246632deebfbd388bae99de5c669929ba63216bc71b2de7dca8a9e4b964 |