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 库的最新版本并将其安装到您的项目中。

在您希望集成客户端的文件中，包含 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');
    }
}

## 配置

将 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：下载最新创建的共同签名中的文件