Download the PHP package landrok/yousign-api without Composer

On this page you can find all versions of the php package landrok/yousign-api. 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?

Informations about the package yousign-api

Yousign API client

Build Status Maintainability Test Coverage

Yousign API client is a wrapper for the Yousign API v2 in PHP.

Its purpose is to use this API without having to write the HTTP calls yourself and then to retrieve the returned data through an object model.

If you still want to make HTTP calls to check the API responses, this is possible thanks to the low-level calls.

It provides several an API wrapper and shortcut methods.

All the API calls are wrapped into an object model. All features are implemented, it aims to be a full-featured client.

All subsequent types (Member, Procedure, File, etc...) are implemented too.

See the full documentation or an overview below.

Table of contents


Requirements


Install


Quick start

In this example, we will get all users in staging mode.

Good news, your token is available.


Responses and data

All API responses are converted into objects that are iterable when it's a collection (ie a list of users) or an item (an user itself).

Dump data

You can use toArray() method to dump all data as a PHP array.

Iterate over a list

You can iterate over all items of a collection.


Basic Mode

Let's create your first signature procedure in basic mode.

In this example, we will accomplish this mode with low-level features.

When the procedure is created, you can retrieve all the data with the getters or dump all data with toJson() and toArray() methods.

It would output something like:


Advanced Mode

Here is how to create a procedure in 5 steps with the advanced mode.

In step 3, you may add several members.

In step 4, you may add one or more signature images for each one.


Branding with signature UI

By default, Signature-UI has the Yousign theme (logo, colors, ...) but you can customize the signature flow embedded in the iFrame from Signature-UI view located in the Admin menu of the app or entirely customize this iFrame by using a specific resource /signature_uis.

In the response below, you will get an id that will be useful to create your iFrame.


More


All versions of yousign-api with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
guzzlehttp/guzzle Version ^7.8
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 landrok/yousign-api contains the following files

Loading the files please wait ....