PHPackages                             lmasforne/yousign-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. lmasforne/yousign-api-client

ActiveLibrary

lmasforne/yousign-api-client
============================

A PHP client for the Yousign API

2.0.4(8y ago)01271PHPPHP &gt;=5.6.0

Since Feb 17Pushed 8y ago1 watchersCompare

[ Source](https://github.com/lmasforne/yousign-api-client-php)[ Packagist](https://packagist.org/packages/lmasforne/yousign-api-client)[ RSS](/packages/lmasforne-yousign-api-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (13)Used By (0)

[![Gitter](https://camo.githubusercontent.com/abe08b740a4156153736f791393ec4da6619c4be73212e75769f52edacc0e2b5/68747470733a2f2f6261646765732e6769747465722e696d2f4a6f696e253230436861742e737667)](https://gitter.im/Yousign/yousign-api-client-php?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)

Client PHP de l'API SOAP Yousign (v1.3.0)
=========================================

[](#client-php-de-lapi-soap-yousign-v130)

Description
-----------

[](#description)

Ce client permet d'utiliser l'[API Soap de Yousign](http://developer.yousign.fr) via le langage PHP.

Eléments requis
---------------

[](#eléments-requis)

- PHP 5.3.3+
- Composer

Installation
------------

[](#installation)

Ajoutez dans votre fichier composer.json :

```
    {
        "require":
        {
            "yousign/yousign-api-client": "~1.3"
        }
    }
```

Ensuite lancez Composer via `php composer.phar update yousign/yousign-api-client`

Installation sans Composer
--------------------------

[](#installation-sans-composer)

Le client utilise par défaut Composer. Néanmoins, si vous ne souhaitez pas l'utiliser, vous pouvez également utiliser ce client. L'installation et les mises à jours se feront juste manuellement.

Commencez par télécharger et décompressez l'archive du projet, ou faites un `git clone https://github.com/Yousign/yousign-api-client-php.git`, dans le répertoire où vous souhaitez installer le client.

Téléchargez également la dernière version de la librairie [NuSoap](http://sourceforge.net/projects/nusoap/) et installez là au sein de votre projet.

Dans le fichier où vous souhaitez intégrer le client, incluez le fichier `src/YsApi.php` ainsi que le fichier `nusoap.php`. Ensuite, créer une instance du client pour l'utiliser.

Exemple :

```
// Inclusion des libraires
require_once __DIR__.'/yousign-api-client-php/src/YsApi.php';
require_once __DIR__.'/lib/nusoap.php';

// Instance du client
$client = new \YousignAPI\YsApi('path/ysApiParameters.ini');

// ...
```

Installation sous Symfony 2.x
-----------------------------

[](#installation-sous-symfony-2x)

Il n'y a pas de bundle actuellement pour le client. Cependant, rien ne vous empêche d'utiliser ce dernier sous forme de service.

Exemple :

Commencez par définir dans votre fichier de paramètres, l'emplacement de votre fichier de configuration.

```
; app/config/parameters.yml

; Copiez/collez `ysApiParameters.ini.dist` dans `app/config/ysApiParameters.ini`

[parameters]
    yousign_parameters_file: "app/config/ysApiParameters.ini"
```

Créez ensuite le service en passant en argument le chemin du fichier de configuration.

```
; app/config/services.yml

parameters:
    yousign.client.class: "YousignAPI\YsApi"

services:
    yousign.client:
        class: "%yousign.client.class%"
        arguments:
            - "%kernel.root_dir%/../%yousign_parameters_file%"
```

Il ne vous reste plus qu'à utiliser le client comme un service.

```
// src/AppBundle/Controller/HelloController.php

namespace AppBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;

class HelloController extends Controller
{
    public function indexAction()
    {
        $client = $this->get('yousign.client');
    }
}
```

\## Configuration

Renommez le fichier `ysApiParameters.ini.dist` en `ysApiParameters.ini` présent dans le répertoire `YousignAPI`et placez le dans le répertoire souhaité.

Modifiez ensuite la configuration avec les paramètres ci-dessous:

- `login` : Votre identifiant Yousign (adresse email)
- `password` : Votre mot de passe
- `api_key` : Votre clé d'API

\## Exemples

Des exemples d'utilisation du client peuvent être trouvés au sein du répertoire `~/YousignAPI/examples`. Lancez le fichier `connection.php` pour vérifier que vous pouvez correctement accéder à l'API Yousign. Si tel est le cas, lancez le script `cosignature_init.php` pour créer une cosignature avec deux utilisateurs et deux fichiers. Vous pouvez ensuite lancer les scripts suivants:

- `cosignature_list.php` : Pour lister les cosignatures créées
- `cosignature_details.php` : Pour afficher les détails de la dernière cosignature créée
- `cosignature_downloadFile.php` : Pour télécharger les fichiers de la dernière cosignature créée

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 70.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~83 days

Recently: every ~12 days

Total

11

Last Release

3266d ago

Major Versions

1.4.0 → 2.0.12017-04-11

PHP version history (2 changes)1.3.0PHP &gt;=5.3

2.0.0PHP &gt;=5.6.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/9c85f679d693dee8c841eb0699a17d6cde61437de6b4c51032a9bc40e8a3239f?d=identicon)[psylo31](/maintainers/psylo31)

---

Top Contributors

[![ke20](https://avatars.githubusercontent.com/u/1608482?v=4)](https://github.com/ke20 "ke20 (12 commits)")[![a-larose](https://avatars.githubusercontent.com/u/1839588?v=4)](https://github.com/a-larose "a-larose (2 commits)")[![matthieuauger](https://avatars.githubusercontent.com/u/1172099?v=4)](https://github.com/matthieuauger "matthieuauger (2 commits)")[![lmasforne](https://avatars.githubusercontent.com/u/2681907?v=4)](https://github.com/lmasforne "lmasforne (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/lmasforne-yousign-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/lmasforne-yousign-api-client/health.svg)](https://phpackages.com/packages/lmasforne-yousign-api-client)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
