phaxio v2 api的python客户端
phaxio的Python项目详细描述
pHaXiO
用于与Phaxio API交互的python模块。
安装
通过PIP:
$ pip install phaxio
使用量
使用HTML消息向多人发送传真:
fromphaxioimportPhaxioApiapi=PhaxioApi(key,secret)response=api.Fax.send(to=['4141234567','5141234567','6151234567'],files='/path/to/supported/file.pdf')print(response.data.id)
全组pHAXIO-API可分为功能组:
api.Fax api.PhoneNumber api.PhaxCode api.Account api.Countries
一般来说,每个受支持的方法都使用 API方法参数的名称与 Phaxio documentation。
有关其他示例,请参见tests,或full documentation。
错误处理
错误将导致ApiException,在正文中包含http状态代码、响应头和json响应数据的字段。
测试
export API_KEY="MY_API_KEY" export API_SECRET="MY_API_SECRET" python setup.py test
贡献
进行api更改
- 更改spec/api.yaml
- 运行make swagger-generate
- 根据需要更改phaxio/api.py。
- 必要时更新文档
- docs/source/phaxio.rst可能不需要更新,除非是非常大的更改
- docs/source/models.rst仅当存在新的模型类型时才需要更新