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

Description

Ce client permet d'utiliser l'API Soap de Yousign via le langage PHP., _(*2)

Eléments requis

PHP 5.3.3+
Composer

Installation

Ajoutez dans votre fichier composer.json :, _(*3)

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

Ensuite lancez Composer via php composer.phar update yousign/yousign-api-client, _(*4)

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., _(*5)

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., _(*6)

Téléchargez également la dernière version de la librairie NuSoap et installez là au sein de votre projet., _(*7)

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., _(*8)

Exemple :, _(*9)

// 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

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., _(*10)

Exemple :, _(*11)

Commencez par définir dans votre fichier de paramètres, l'emplacement de votre fichier de configuration., _(*12)

; 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., _(*13)

; 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., _(*14)

// 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é., _(*15)

Modifiez ensuite la configuration avec les paramètres ci-dessous:, _(*16)

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:, _(*17)

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