Download the PHP package hellosign/hellosign-php-sdk without Composer

On this page you can find all versions of the php package hellosign/hellosign-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of hellosign/hellosign-php-sdk

Informations about the package hellosign-php-sdk

⚠ This SDK has been deprecated ⚠

This SDK is now deprecated and will no longer receive feature updates or bug fixes. Security fixes will still be applied as needed.

The new dropbox/sign SDK can be found at hellosign/dropbox-sign-php!

The new SDK and this legacy SDK are not backwards-compatible!

Please see here for a comprehensive migration guide.

HelloSign PHP SDK

Build Status

This is the official PHP SDK for HelloSign's API. View API Documentation and Examples.

Installation

Requirements

The latest version of the SDK requires PHP version 8.0 or higher. For PHP 7.x use SDK version 3.7.*

You can import this SDK into your library two ways, either through including the base HelloSign.php file into your project or using Composer.

To use Composer:

Configuration

All HelloSign API requests can be made using the HelloSign\Client class. This class must be initialized with your authentication details such as an API key (preferred), email/password combo, or OAuth credentials.

API key Config

Email/Password Config

Oauth Config

Your app users are almost ready to start signing! See below for the most common use cases for this wrapper.

Usage

You can test your authentication by calling

Retrieving fields returned from the API

Using magic methods

Or if you want to get all attributes in an array

Creating a Signature Request

To specify a URL to a remote file instead use:

If you are using Text Tags in your document, you can enable and configure them through the respective methods:

Or if you want to set Form Fields per Document:

Retrieving a User's Templates

The HelloSign API provides paged lists for user templates and signature requests. These lists are represented as objects that can be iterated upon.

Creating a Signature Request from a Template

Checking the Status of a Signature Request

Creating an Embedded Signature Request to use for Embedded Signing

Refer to the (Embedded Signing Walkthrough)[https://app.hellosign.com/api/embeddedSigningWalkthrough] for more details.

Creating an Embedded Template draft

Creating an Unclaimed Draft to use for Embedded Requesting

Enabling OAuth

Displaying warnings

Any warnings returned from the API can be accessed via the returned object / list via the getWarnings method:

``

Testing

This project contains PHPUnit tests that check the SDK code and can also be referenced for examples. Most are functional and integrated tests that walk through real user scenarios.

In order to pass the unit tests, you will need:

  1. The API Key for a confirmed HelloSign account
  2. The client ID and secret key from a confirmed HelloSign API App
  3. A HelloSign subscription (to create a team)
  4. A HelloSign API subscription (to access paid API endpoints)
  5. A template with 1 signer role named 'Signer'
  6. A Team with 1 additional team member

*** WARNING: these tests will add and remove users from your team. Use with caution.

To run the tests

License

All versions of hellosign-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0|8.1
guzzlehttp/guzzle Version ^6.3|^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hellosign/hellosign-php-sdk contains the following files

Loading the files please wait ....