Yousign API Python Client

https://github.com/yousign/yousign-api-client-python
Admin
A Python client library for interacting with the Yousign API, enabling signature processes, document...
Tokens:654
Snippets:4
Trust Score:6.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Python Client for Yousign API

Source: https://github.com/yousign/yousign-api-client-python/blob/master/README.md

Instructions to clone the repository and install the Python client using setup.py. This prepares the environment for using the Yousign API client.

```bash
git clone https://github.com/Yousign/yousign-api-client-python.git
```

```bash
python setup.py install
```

--------------------------------

### Initialize Yousign API Client in Python

Source: https://github.com/yousign/yousign-api-client-python/blob/master/README.md

Demonstrates two ways to initialize the Yousign API client in Python: either by loading settings from a configuration file or by directly providing user credentials and environment details. This step is crucial for establishing a connection to the Yousign API.

```python
c = ysApi.ApiClient('../config/config.ini')
```

```python
c = ysApi.ApiClient(None, username,
                       password, => (encrypted),
                       apikey,
                       environment
```

--------------------------------

### Yousign API Client Configuration Parameters

Source: https://github.com/yousign/yousign-api-client-python/blob/master/README.md

Details the essential parameters required for configuring the Yousign API client, including credentials and environment settings. It also specifies the password encryption method used for secure authentication.

```APIDOC
Configuration Parameters:
  login: Your login (email address)
  password: Your password
  apikey: Your API Key
  environment: demo or prod
  isEncryptedPassword: true if you use an encrypted password, false if not.

Password Hashing:
  Calculation: sha1(sha1(clearPassword)+sha1(clearPassword))
  Example: If clearPassword = "test123", password = "6bc498d4dc47ec2177ff42151139da01c1660ddf"
```

--------------------------------

### Yousign API Client Core Functionalities

Source: https://github.com/yousign/yousign-api-client-python/blob/master/README.md

Overview of key functionalities provided by the Yousign API client, including operations for managing signature processes (initialization, download, details, listing, alerts, cancellation) and document archiving. Each function allows interaction with specific aspects of the Yousign SOAP API.

```APIDOC
API Functionalities:
  signature_init: Initialize a signature process.
  signature_downloadFile: Get signed files associated with a signature process from an idDemand or a token.
  signature_details: Get information (status, name, file info) about a signature process from an idDemand or a token.
  signature_list: Get information of all your signature processes.
  signature_alert: Alert signers who have not signed document(s) yet.
  signature_cancel: Cancel a signature process which is not finished yet.
  archive: Archive document for 10 years with metadatas. Metadatas are used to find easily one (or several) archive.
  getArchive: Get archive file identified by its iua.
  getCompleteArchive: Get complete archive file identified by its iua.
```
Tokens:
Raw