docusign/admin-client

The DocuSign Admin API enables you to automate user management with your existing systems while ensuring governance and compliance.

v1.4.2-rc1 2024-03-20 13:02 UTC

README

Build status

Requirements

Compatibility

  • PHP 7.4+

Note

This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the Developer Center, follow the installation instructions below.

Installation

Composer:

  1. In your PHP console , type:
    Composer require docusign/admin-client;
  2. To use the package automatically, add to Composer's Autoload file:
    require_once('vendor/autoload.php');

Manual install:

  1. Download or clone this repository.
  2. Bind the PHP SDK to your server or place it in a static location.
    1. To bind to your server, edit the init.php file. Add:
      require_once('/path/to/docusign-admin-client/autoload.php');
    2. To bind to single pages: In your PHP file that will utilize the PHP SDK, add:
      `require_once('/path/to/docusign-admin-client/autoload.php');

Dependencies

This client has the following external dependencies:

Code Examples

Launchers

DocuSign provides a sample application referred to as a Launcher. The Launcher contains a set of 18 common use cases and associated source files. These examples use DocuSign's Authorization Code Grant flow.

Proof-of-concept applications

If your goal is to create a proof-of-concept application, DocuSign provides a set of Quick Start examples. The Quick Startexamples are meant to be used with DocuSign's OAuth Token Generator, which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.

OAuth Implementations

For details regarding which type of OAuth grant will work best for your DocuSign integration, see the REST API Authentication Overview guide located on the DocuSign Developer Center.

For security purposes, DocuSign recommends using the Authorization Code Grant flow.

There are other use-case scenarios, such as single-page applications (SPA) that use Cross-Origin Resource Sharing (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports JWT and Implicit grants. For code examples, see the links below:

Support

Log issues against this client through GitHub. We also have an active developer community on Stack Overflow.

License

The DocuSign Admin PHP Client is licensed under the MIT License.