PHP YousignAPI\YsApi Examples

Example #1

File: cosignature_details.php Project: ConstantSIDJUI/yousign-api-client-php

 * 
 * Ici on récupère les détails de la dernière cosignature créée.
 * La variable "$idDemand" peut-être définie directement pour récupérer les informations associées à celles-ci.
 * 
 * Remarque :
 * ----------
 *
 * L'utilisateur doit être authentifié (cf l'exemple: 'connection.php')
 * 
 */
// Inclusion du loader
$loader = (require_once dirname(__FILE__) . '/../vendor/autoload.php');
// Définition du chemin de configuration
$configFile = dirname(__FILE__) . '/../ysApiParameters.ini';
// Création du client en passant les identifiants en paramètres
$client = new \YousignAPI\YsApi($configFile);
// Récupération de la dernière cosignature créée (voir cosignature_list.php)
$result = $client->getListCosign(array('count' => 1));
if ($result === false) {
    echo 'Une erreur est survenue : ';
    var_dump($client->getErrors());
    exit;
}
if (count($result) === 0) {
    echo 'Aucune cosignature de créée pour le moment.';
    exit;
}
// Récupération des informations de la cosignature
$idDemand = $result[0]['cosignatureEvent'];
$result = $client->getCosignInfoFromIdDemand($idDemand);
// Affichage des résultats

Example #2

File: cosignature_init.php Project: ConstantSIDJUI/yousign-api-client-php

 * Cet exemple permet de créer une cosignature.
 * 
 * Ici une signature avec 2 fichiers et 2 signataires.
 *
 * Remarque :
 * ----------
 *
 * L'utilisateur doit être authentifié (cf l'exemple: 'connection.php')
 * 
 */
// Inclusion du loader
$loader = (require_once dirname(__FILE__) . '/../vendor/autoload.php');
// Définition du chemin de configuration
$configFile = dirname(__FILE__) . '/../ysApiParameters.ini';
// Création du client en passant les identifiants en paramètres
$client = new \YousignAPI\YsApi($configFile);
// Chemin des fichiers à signer
$pathFile1 = dirname(__FILE__) . '/documents/document1.pdf';
$pathFile2 = dirname(__FILE__) . '/documents/document2.pdf';
// Création de la liste des fichiers à signer
$listFiles = array(array('name' => basename($pathFile1), 'content' => base64_encode(file_get_contents($pathFile1)), 'idFile' => $pathFile1), array('name' => basename($pathFile2), 'content' => base64_encode(file_get_contents($pathFile2)), 'idFile' => $pathFile2));
// Création de la liste des signataires
$listPerson = array(array('firstName' => 'Jean', 'lastName' => 'Dupont', 'mail' => '*****@*****.**', 'phone' => '+33623456789', 'proofLevel' => 'LOW', 'authenticationMode' => 'sms'), array('firstName' => 'Hervé', 'lastName' => 'Martin', 'mail' => '*****@*****.**', 'phone' => '+33632654987', 'proofLevel' => 'LOW', 'authenticationMode' => 'sms'));
// Placement des signatures sur le document
$visibleOptions = array($listFiles[0]['idFile'] => array(array('visibleSignaturePage' => '1', 'isVisibleSignature' => true, 'visibleRectangleSignature' => '351,32,551,132', 'mail' => '*****@*****.**'), array('visibleSignaturePage' => '1', 'isVisibleSignature' => true, 'visibleRectangleSignature' => '48,32,248,132', 'mail' => '*****@*****.**')), $listFiles[1]['idFile'] => array(array('visibleSignaturePage' => '2', 'isVisibleSignature' => true, 'visibleRectangleSignature' => '351,32,551,132', 'mail' => '*****@*****.**'), array('visibleSignaturePage' => '2', 'isVisibleSignature' => true, 'visibleRectangleSignature' => '48,32,248,132', 'mail' => '*****@*****.**')));
// Message vide car on est en mode Iframe
$message = '';
// Autres options
$options = array('mode' => 'IFRAME', 'archive' => false);
// Appel du client et récupération du résultat
$result = $client->initCoSign($listFiles, $listPerson, $visibleOptions, $message, $options);

Example #3

File: connection.php Project: ConstantSIDJUI/yousign-api-client-php

/**
 * Cet exemple permet de :
 *     - vérifier que la configuration du client soit correct 
 *     - vérifier que l'utilisateur puisse utiliser l'API
 *
 * 
 * Remarque : 
 * ----------
 * 
 * La méthode "connect()" permet de vérifier si l'utilisateur a bien accès à l'API.
 * 
 * L'utilisation des autres méthodes ne nécessite pas de passer obligatoirement
 * par la méthode "connect()".
 * 
 */
// Inclusion du loader
$loader = (require_once dirname(__FILE__) . '/../vendor/autoload.php');
// Définition du chemin de configuration
$configFile = dirname(__FILE__) . '/../ysApiParameters.ini';
// Création du client en passant les identifiants en paramètres
$client = new \YousignAPI\YsApi($configFile);
// Connection à l'API
$client->connect();
// Vérification que la connexion ait fonctionnée
if (!$client->isAuthenticated()) {
    echo 'Vous n\'avez pas d\'accès à l\'API Yousign ou une erreur est survenue : ';
    var_dump($client->getErrors());
} else {
    echo 'Félicitation, vous êtes authentifié';
}

Example #4

File: cosignature_downloadFile.php Project: ConstantSIDJUI/yousign-api-client-php

 * 
 * Ici on récupère les détails de la dernière cosignature créée.
 * La variable "$idDemand" peut-être définie directement pour récupérer les informations associées à celles-ci.
 *
 * Remarque :
 * ----------
 *
 * L'utilisateur doit être authentifié (cf l'exemple: 'connection.php')
 * 
 */
// Inclusion du loader
$loader = (require_once dirname(__FILE__) . '/../vendor/autoload.php');
// Définition du chemin de configuration
$configFile = dirname(__FILE__) . '/../ysApiParameters.ini';
// Création du client en passant les identifiants en paramètres
$client = new \YousignAPI\YsApi($configFile);
// Récupération de la dernière cosignature créée (voir cosignature_list.php)
$result = $client->getListCosign(array('count' => 1));
if ($result === false) {
    echo 'Une erreur est survenue : ';
    var_dump($client->getErrors());
    exit;
}
if (count($result) === 0) {
    echo 'Aucune cosignature de créée pour le moment.';
    exit;
}
$resultDetails = array();
$downloadLinks = array();
$idDemand = $result[0]['cosignatureEvent'];
$listFiles = $result[0]['fileInfos'];

Example #5

File: cosignature_with_text_to_write.php Project: ConstantSIDJUI/yousign-api-client-php

 * Cet exemple permet de créer une cosignature.
 *
 * Ici une signature avec 2 fichiers et 2 signataires.
 *
 * Remarque :
 * ----------
 *
 * L'utilisateur doit être authentifié (cf l'exemple: 'connection.php')
 *
 */
// Inclusion du loader
$loader = (require_once dirname(__FILE__) . '/../vendor/autoload.php');
// Définition du chemin de configuration
$configFile = dirname(__FILE__) . '/../ysApiParameters.ini';
// Création du client en passant les identifiants en paramètres
$client = new \YousignAPI\YsApi($configFile);
// Chemin des fichiers à signer
$pathFile1 = dirname(__FILE__) . '/documents/document1.pdf';
$pathFile2 = dirname(__FILE__) . '/documents/document2.pdf';
// Création de la liste des fichiers à signer
$listFiles = array(array('name' => basename($pathFile1), 'content' => base64_encode(file_get_contents($pathFile1)), 'idFile' => $pathFile1), array('name' => basename($pathFile2), 'content' => base64_encode(file_get_contents($pathFile2)), 'idFile' => $pathFile2));
// Création de la liste des signataires
$listPerson = array(array('firstName' => 'Jean', 'lastName' => 'Dupont', 'mail' => '*****@*****.**', 'phone' => '+33623456789', 'proofLevel' => 'LOW', 'authenticationMode' => 'sms'), array('firstName' => 'Hervé', 'lastName' => 'Martin', 'mail' => '*****@*****.**', 'phone' => '+33632654987', 'proofLevel' => 'LOW', 'authenticationMode' => 'sms'));
// Placement des signatures sur le document
$visibleOptions = array($listFiles[0]['idFile'] => array(array('visibleSignaturePage' => '1', 'isVisibleSignature' => true, 'visibleRectangleSignature' => '351,32,551,132', 'mail' => '*****@*****.**'), array('visibleSignaturePage' => '1', 'isVisibleSignature' => true, 'visibleRectangleSignature' => '48,32,248,132', 'mail' => '*****@*****.**')), $listFiles[1]['idFile'] => array(array('visibleSignaturePage' => '2', 'isVisibleSignature' => true, 'visibleRectangleSignature' => '351,32,551,132', 'mail' => '*****@*****.**'), array('visibleSignaturePage' => '2', 'isVisibleSignature' => true, 'visibleRectangleSignature' => '48,32,248,132', 'mail' => '*****@*****.**')));
// Message vide car on est en mode Iframe
$message = '';
// Autres options
$options = array('mode' => 'IFRAME', 'archive' => false);
// Appel du client et récupération du résultat
$result = $client->initCoSign($listFiles, $listPerson, $visibleOptions, $message, $options);

Example #6

File: cosignature_list.php Project: ConstantSIDJUI/yousign-api-client-php

/**
 * Cet exemple permet de récupérer les cosignatures créées.
 * Ici, les 30 dernières demandes de signature peu importe le statut.
 *
 * Remarque :
 * ----------
 *
 * L'utilisateur doit être authentifié (cf l'exemple: 'connection.php')
 * 
 */
// Inclusion du loader
$loader = (require_once dirname(__FILE__) . '/../vendor/autoload.php');
// Définition du chemin de configuration
$configFile = dirname(__FILE__) . '/../ysApiParameters.ini';
// Création du client en passant les identifiants en paramètres
$client = new \YousignAPI\YsApi($configFile);
// Options de recherche
$options = array('search' => '', 'firstResult' => 0, 'count' => 30, 'status' => '');
// Appel du client
$result = $client->getListCosign($options);
// Affichage du/des résultats
if ($result === false) {
    echo 'Une erreur est survenue :';
    var_dump($client->getErrors());
} else {
    echo 'Listing des cosignatures récupérées : ';
    foreach ($result as $value) {
        var_dump($value);
        echo '<hr />';
    }
}