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.
Download landrok/yousign-api
More information about landrok/yousign-api
Files in landrok/yousign-api
Package yousign-api
Short Description A PHP implementation of YouSign API.
License MIT
Homepage https://yousign-api.readthedocs.io
Informations about the package yousign-api
Yousign API client
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
- Basic mode
- Advanced mode
- Branding with signature UI
Requirements
- PHP 7.4+
- You have to create your account on Yousign platform to get an API token before using this library.
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
-
To discuss new features, make feedback or simply to share ideas, you can contact me on Mastodon at https://cybre.space/@landrok
-
Create an account and an API token on Yousign Sandbox sign-up
- Official API manual