README

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库的最新版本（http://sourceforge.net/projects/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下的安装

目前没有针对此客户端的bundle。但是，您可以使用它作为服务。

示例

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

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

## 配置

将ysApiParameters.ini.dist文件重命名为ysApiParameters.ini，位于YousignAPI目录中，并将其放置在所需的目录。

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

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

## 示例

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

• cosignature_list.php：列出创建的共签名
• cosignature_details.php：显示最新创建的共签名的详细信息
• cosignature_downloadFile.php：下载最新创建的共签名中的文件