hellosign api的python包装器（http://www.hellosign.com/api）
hellosign-python-sdk的Python项目详细描述
hellosign python sdk
----
[hellosign api]的python包装（http://www.hellosign.com/api）
` pip`：
````sh
pip安装hellosign python sdk
`````````
从代码安装：
`````sh
git克隆https://github.com/hellofax/hellosign python sdk.git
cd hellosign python sdk
python setup.py install
``````
导入"hsclient"：
```python
from hellosign-sdk导入hsclient
``````
，然后创建一个hsclient对象并传递身份验证信息来初始化它：
```python
=hsclient（email_address="api_user@example.com"，password="your廑password"）
凭据，优先级顺序如下：访问令牌、API密钥，然后是电子邮件和密码。
其方法和参数请访问我们在[readthedocs]上的详细api文档（http://hellosign python sdk.readthedocs.org/en/v3/py modindex.html）。
帐户信息也存储在"client.account"中。例如，要打印帐户的"电子邮件地址"：
```python
print client.account.email地址
``````
``python
client.account.callback="https://www.example.com/callback"
client.update\account\account.update\account\
````````
```````````````新建一个新的hellosign账户
``````````````````````````````````````新的帐户=client.cre创建一个新的帐户（new\user@exampl.com```````````````
签名请求
````python
signature\u request=client.get\u signature\u request（"fa5c8a0b0f492d768749333ad6fcc214c11e967"）
print signature\u request.requester\u email\u address
print signature\u request.signature\u id
`````
请求
````python
signature_request_list=client.get_signature_request_list（page=1）
签名请求。签名[0]。签名者姓名
````
````python
```files=["nda.pdf"，"appendix.pdf"]
签名者=[
{"姓名"："杰克"，"电子邮件地址"："jack@example.com"}，
{"姓名"："吉尔"，"电子邮件地址"："jill@example.com"}
]
cc_电子邮件地址=["lawyer@hellosign.com"，"lawyer@example.com"]
files=none，
file_url=["http://www.example.com/download/sample.pdf"]，
title="与acme公司的保密协议"，
subject="我们讨论的保密协议"，
message="请签署此保密协议，然后我们可以进一步讨论。如果您有任何问题，请告诉我。"，
签名重定向URL=无，
签名者=签名者，
cc_email_addresses=cc_email_addresses）
/>test_mode=true，
files=files，
file_url=none，
title="与acme公司的保密协议"，
subject="我们讨论的保密协议"，
message="请签署此保密协议，然后我们可以进一步讨论。如果您有任何问题，请告诉我。"，
签名重定向URL=无，
签名者=签名者，
cc_email_addresses=cc_email_addresses）
`````
```python
{signers=[
{"name"："jack"，"email_address"："jack@example.com"}，
{"name"："jill"，"email-address"："jill@example.com"}
]
cc-email-addresses=["layer@hellosign.com"，"layer@example.com"]
ccs=[
{"email-address"："layer@hellosign.com"，"role-name"："layer 1"}，
{"email-address"："layer@example.com"，"角色名称"："律师2"}
]
自定义字段=[
{"字段1"："值1"}，
{"字段2"："值2"}
]
模板"fa5c8a0b0f492d768749333ad6fcc214c11e967"，
标题"与acme公司的保密协议"，
主题"我们讨论的保密协议"，
message="请签署此保密协议，然后我们可以进一步讨论。如果您有任何问题，请告诉我。"，
签名重定向url=none，
签名者=signers，
ccs=ccs，
自定义字段=自定义字段）
````
嵌入
嵌入签名
```python
签名者=[
"姓名"："杰克"，"电子邮件地址"："jack@example.com"}，
{"姓名"："jill"，"电子邮件地址"："jill@example.com"}
]
signature_request=client.send_signature_request_embedded（
test_mode=true，
client_id="your client id"，
files=["path/to/nda.pdf"]，
title="与Acme公司签订保密协议"，
subject="我们讨论过的保密协议"，
message="请签署此保密协议，然后我们可以进一步讨论。如果有任何问题，请告诉我。"，
签名重定向url=none
签名者=签名者，
抄送电子邮件地址=none，
form_fields_per_document=无）
=嵌入式obj.sign_url
````
url
draft=client.create_embedded_unclaired_draft（
test_mode=true，
client_id="your client id"，
requester_email_address="requester@example.com"，
files=["path/to/nda.pdf"]，
draft_type="signature_request"、
subject="我们讨论过的保密协议"、
message="请签署此保密协议，然后我们可以讨论更多内容。让我知道如果你有任何问题。"，
是指嵌入的签名=false）
声明的URL=草稿。声明的URL
``````
有关关联的前端代码的更多信息，请参见[此处]（https://www.hellosign.com/api/embeddedrequestingwalkthrough\clientsiderequesting）
用户在嵌入的iframe中编辑草稿并发送签名请求您的应用回调将收到一个包含"signature request"对象的"signature\u request\u sent"事件。如果我们使用了"is_for_embedded_signing=true"，那么我们希望从该事件的"signaturerequest"中获取签名id，并在此时获取签名url。在事件回调处理程序中，您需要这样做：
````python
client=hsclient（api_key='your_api_key'）
event_data=json.loads（request.post.get（'json'）
if event_data['event']['event_type']='signature_request_sent'：
sig_req=event_data['signature_request']
sig_req['signature_request']['signatures']：
embedded_obj=client.get_embedded_object（sig['signature_id']）
sign_url=embedded_obj.sign_url
克隆repo之后的命令：
请注意，它需要有一个hellosign帐户，使用至少一个模板和一个api应用程序。
**警告：**我们建议不要对您的个人帐户运行测试，因为它们会执行破坏性操作。
````
cd hellosign_sdk
cp tests/test_helper.sample.py tests/test_helper.py
hellosign_api key='您的apikey'
hellosign_api_client_id='您的应用程序客户端id'
hellosign_api_client_secret='您的应用程序客户端secret'
noests--带覆盖率--cover package=hellosign_sdk--include=hellosign_sdk/tests/unit_tests/*--include=hellosign_sdk/tests/functional_tests/*
`````
注意：本地回调不允许将应用回调（event或oauth）设置为localhost。但是，仍然可以对本地服务器测试回调。隧道服务，如[ngrok]（http://ngrok.com）可以帮助您设置此设置。
向任何获得本软件和相关文档文件（以下简称"软件"）副本的人，无限制地处理本软件中的
，包括但不限于使用、复制、修改、合并、发布、分发、再授权和/或出售
本软件副本的权利，并允许向其提供该软件的人这样做，但须符合以下条件：
上述版权声明和本许可声明应包括在该软件的所有
副本或实质性部分中。
任何形式的明示或暗示保证，包括但不限于适销性保证、特定用途适用性保证和非侵权性保证。在任何情况下，
作者或版权所有人都不对任何索赔、损害或其他
责任负责，无论是在合同诉讼、侵权诉讼或其他诉讼中，由软件或
软件的使用或其他交易引起的或与之相关的。
----
[hellosign api]的python包装（http://www.hellosign.com/api）
` pip`：
````sh
pip安装hellosign python sdk
`````````
从代码安装：
`````sh
git克隆https://github.com/hellofax/hellosign python sdk.git
cd hellosign python sdk
python setup.py install
``````
导入"hsclient"：
```python
from hellosign-sdk导入hsclient
``````
，然后创建一个hsclient对象并传递身份验证信息来初始化它：
```python
=hsclient（email_address="api_user@example.com"，password="your廑password"）
凭据，优先级顺序如下：访问令牌、API密钥，然后是电子邮件和密码。
其方法和参数请访问我们在[readthedocs]上的详细api文档（http://hellosign python sdk.readthedocs.org/en/v3/py modindex.html）。
帐户信息也存储在"client.account"中。例如，要打印帐户的"电子邮件地址"：
```python
print client.account.email地址
``````
``python
client.account.callback="https://www.example.com/callback"
client.update\account\account.update\account\
````````
```````````````新建一个新的hellosign账户
``````````````````````````````````````新的帐户=client.cre创建一个新的帐户（new\user@exampl.com```````````````
签名请求
````python
signature\u request=client.get\u signature\u request（"fa5c8a0b0f492d768749333ad6fcc214c11e967"）
print signature\u request.requester\u email\u address
print signature\u request.signature\u id
`````
请求
````python
signature_request_list=client.get_signature_request_list（page=1）
签名请求。签名[0]。签名者姓名
````
````python
```files=["nda.pdf"，"appendix.pdf"]
签名者=[
{"姓名"："杰克"，"电子邮件地址"："jack@example.com"}，
{"姓名"："吉尔"，"电子邮件地址"："jill@example.com"}
]
cc_电子邮件地址=["lawyer@hellosign.com"，"lawyer@example.com"]
files=none，
file_url=["http://www.example.com/download/sample.pdf"]，
title="与acme公司的保密协议"，
subject="我们讨论的保密协议"，
message="请签署此保密协议，然后我们可以进一步讨论。如果您有任何问题，请告诉我。"，
签名重定向URL=无，
签名者=签名者，
cc_email_addresses=cc_email_addresses）
/>test_mode=true，
files=files，
file_url=none，
title="与acme公司的保密协议"，
subject="我们讨论的保密协议"，
message="请签署此保密协议，然后我们可以进一步讨论。如果您有任何问题，请告诉我。"，
签名重定向URL=无，
签名者=签名者，
cc_email_addresses=cc_email_addresses）
`````
```python
{signers=[
{"name"："jack"，"email_address"："jack@example.com"}，
{"name"："jill"，"email-address"："jill@example.com"}
]
cc-email-addresses=["layer@hellosign.com"，"layer@example.com"]
ccs=[
{"email-address"："layer@hellosign.com"，"role-name"："layer 1"}，
{"email-address"："layer@example.com"，"角色名称"："律师2"}
]
自定义字段=[
{"字段1"："值1"}，
{"字段2"："值2"}
]
模板"fa5c8a0b0f492d768749333ad6fcc214c11e967"，
标题"与acme公司的保密协议"，
主题"我们讨论的保密协议"，
message="请签署此保密协议，然后我们可以进一步讨论。如果您有任何问题，请告诉我。"，
签名重定向url=none，
签名者=signers，
ccs=ccs，
自定义字段=自定义字段）
````
嵌入
嵌入签名
```python
签名者=[
"姓名"："杰克"，"电子邮件地址"："jack@example.com"}，
{"姓名"："jill"，"电子邮件地址"："jill@example.com"}
]
signature_request=client.send_signature_request_embedded（
test_mode=true，
client_id="your client id"，
files=["path/to/nda.pdf"]，
title="与Acme公司签订保密协议"，
subject="我们讨论过的保密协议"，
message="请签署此保密协议，然后我们可以进一步讨论。如果有任何问题，请告诉我。"，
签名重定向url=none
签名者=签名者，
抄送电子邮件地址=none，
form_fields_per_document=无）
=嵌入式obj.sign_url
````
url
draft=client.create_embedded_unclaired_draft（
test_mode=true，
client_id="your client id"，
requester_email_address="requester@example.com"，
files=["path/to/nda.pdf"]，
draft_type="signature_request"、
subject="我们讨论过的保密协议"、
message="请签署此保密协议，然后我们可以讨论更多内容。让我知道如果你有任何问题。"，
是指嵌入的签名=false）
声明的URL=草稿。声明的URL
``````
有关关联的前端代码的更多信息，请参见[此处]（https://www.hellosign.com/api/embeddedrequestingwalkthrough\clientsiderequesting）
用户在嵌入的iframe中编辑草稿并发送签名请求您的应用回调将收到一个包含"signature request"对象的"signature\u request\u sent"事件。如果我们使用了"is_for_embedded_signing=true"，那么我们希望从该事件的"signaturerequest"中获取签名id，并在此时获取签名url。在事件回调处理程序中，您需要这样做：
````python
client=hsclient（api_key='your_api_key'）
event_data=json.loads（request.post.get（'json'）
if event_data['event']['event_type']='signature_request_sent'：
sig_req=event_data['signature_request']
sig_req['signature_request']['signatures']：
embedded_obj=client.get_embedded_object（sig['signature_id']）
sign_url=embedded_obj.sign_url
克隆repo之后的命令：
请注意，它需要有一个hellosign帐户，使用至少一个模板和一个api应用程序。
**警告：**我们建议不要对您的个人帐户运行测试，因为它们会执行破坏性操作。
````
cd hellosign_sdk
cp tests/test_helper.sample.py tests/test_helper.py
hellosign_api key='您的apikey'
hellosign_api_client_id='您的应用程序客户端id'
hellosign_api_client_secret='您的应用程序客户端secret'
noests--带覆盖率--cover package=hellosign_sdk--include=hellosign_sdk/tests/unit_tests/*--include=hellosign_sdk/tests/functional_tests/*
`````
注意：本地回调不允许将应用回调（event或oauth）设置为localhost。但是，仍然可以对本地服务器测试回调。隧道服务，如[ngrok]（http://ngrok.com）可以帮助您设置此设置。
向任何获得本软件和相关文档文件（以下简称"软件"）副本的人，无限制地处理本软件中的
，包括但不限于使用、复制、修改、合并、发布、分发、再授权和/或出售
本软件副本的权利，并允许向其提供该软件的人这样做，但须符合以下条件：
上述版权声明和本许可声明应包括在该软件的所有
副本或实质性部分中。
任何形式的明示或暗示保证，包括但不限于适销性保证、特定用途适用性保证和非侵权性保证。在任何情况下，
作者或版权所有人都不对任何索赔、损害或其他
责任负责，无论是在合同诉讼、侵权诉讼或其他诉讼中，由软件或
软件的使用或其他交易引起的或与之相关的。
欢迎加入QQ群-->： 979659372
