README

新API是RESTful的，且没有官方客户端。

您可以在以下链接找到新API文档 > https://dev.yousign.com/?version=latest

如果您需要，存在一些非官方客户端： https://github.com/search?q=yousign

Yousign SOAP API的PHP客户端（v1.3.0）

描述

此客户端允许通过PHP语言使用Yousign的SOAP API。

所需元素

• PHP 5.3.3+
• Composer

安装

在您的composer.json文件中添加

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

然后通过php composer.phar update yousign/yousign-api-client启动Composer

无Composer安装

客户端默认使用Composer。不过，如果您不想使用它，您也可以使用此客户端。安装和更新将通过手动完成。

首先，下载并解压缩项目存档，或者通过git clone https://github.com/Yousign/yousign-api-client-php.git在您希望安装客户端的目录中。

同时，下载NuSoap库的最新版本并将其安装到您的项目中。

在您希望集成客户端的文件中，包括src/YsApi.php和nusoap.php文件。然后，创建一个客户端实例以使用它。

示例

// 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');

// ...

在Symfony 2.x下安装

目前没有为此客户端提供任何捆绑包。但是，您可以使用它作为服务的形式。

示例

首先，在您的参数文件中定义配置文件的路径。

; app/config/parameters.yml

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

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

然后，通过传递配置文件的路径来创建服务。

; app/config/services.yml

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

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

然后，您只需像使用服务一样使用客户端。

// 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');
    }
}

## 配置

将YousignAPI目录中的ysApiParameters.ini.dist文件重命名为ysApiParameters.ini并将其放置在您选择的目录中。

然后使用以下参数修改配置

• login：您的Yousign标识（电子邮件地址）
• password：您的密码
• api_key：您的API密钥

## 示例

客户端的使用示例可以在~/YousignAPI/examples目录中找到。运行connection.php文件以检查您是否可以正确访问Yousign API。如果可以，请运行cosignature_init.php脚本以创建两个用户和两个文件的联合签名。然后，您可以运行以下脚本

• cosignature_list.php：列出创建的联合签名
• cosignature_details.php : 用于显示最新创建的联合签名详情
• cosignature_downloadFile.php : 用于下载最新创建的联合签名文件