Signplus Python SDK 1.4.0

Welcome to the Signplus SDK documentation. This guide will help you get started with integrating and using the Signplus SDK in your project.

Versions

• API version: 2.5.0
• SDK version: 1.4.0

About the API

Integrate legally-binding electronic signature to your workflow

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • Access Token Authentication
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install signplus-python

Authentication

Access Token Authentication

The Signplus API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows:

Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

If you need to set or update the access token after initializing the SDK, you can use:

sdk.set_access_token("YOUR_ACCESS_TOKEN")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from signplus import Signplus

sdk = Signplus(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_envelope(envelope_id="envelope_id")

print(result)

Async Usage

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

import asyncio
from signplus import SignplusAsync

sdk = SignplusAsync(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)


async def main():
  result = await sdk.signplus.get_envelope(envelope_id="envelope_id")
  print(result)

asyncio.run(main())

Services

The SDK provides various services to interact with the API.

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.