vigicorp / yousign-api-v3
通过您的平台提供数字签名的最佳体验。使用 Yousign API 提高您的转化率,利用您的数据并降低您的成本。
1.0.4
2024-09-19 15:20 UTC
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
通过您的平台提供数字签名的最佳体验。使用 Yousign API 提高您的转化率,利用您的数据并降低您的成本。
安装和用法
需求
PHP 7.4 及更高版本。也应与 PHP 8.0 兼容。
Composer
要通过 Composer 安装绑定,请将以下内容添加到 composer.json
{ "repositories": [ { "type": "vcs", "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" } ], "require": { "GIT_USER_ID/GIT_REPO_ID": "*@dev" } }
然后运行 composer install
手动安装
下载文件并包含 autoload.php
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
入门指南
请按照安装程序进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure Bearer authorization: bearerAuth $config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Yousign\Client\Api\ApproverApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $signature_request_id = 'signature_request_id_example'; // string | Signature Request Id $approver_id = 'approver_id_example'; // string | Approver Id try { $apiInstance->deleteSignatureRequestsSignatureRequestIdApproversApproverId($signature_request_id, $approver_id); } catch (Exception $e) { echo 'Exception when calling ApproverApi->deleteSignatureRequestsSignatureRequestIdApproversApproverId: ', $e->getMessage(), PHP_EOL; }
API 端点
所有 URI 都相对于 https://api-sandbox.yousign.app/v3
模型
- 审批者
- 审批者信息
- 需要通知的审批者
- 存档文件
- 存档
- 审计跟踪区域
- 复选框
- 复选框1
- 复选框2
- 消费
- 消费 API
- 消费应用
- 消费应用合格电子签名识别模式
- 消费应用合格电子签名识别模式身份验证
- 联系人
- 创建联系人
- 创建自定义体验
- 创建自定义体验重定向 URL
- 从多部分创建文档
- 创建电子印章字段只读文本有效负载
- 创建电子印章字段印章有效负载
- 创建电子印章有效负载
- 创建电子印章有效负载字段内部
- 创建字段
- 创建字段字体
- 创建关注者内部
- 创建签名请求
- 创建签名请求元数据
- 创建签名请求提醒设置
- 创建签名请求签署者内部
- 创建签名请求模板占位符
- 创建签名请求模板占位符签署者内部
- 创建签署者
- 创建签署者文档请求
- 创建 Webhook 订阅
- 创建 Webhook 订阅作用域
- 创建 Webhook 订阅订阅事件
- 创建 Webhook 订阅工作区
- 创建工作区
- 自定义体验
- 自定义体验禁用通知类型
- 自定义体验重定向 URL
- 自定义体验来源
- 文档
- 文档首字母
- 电子印章
- 电子印章审计跟踪
- 电子印章文档
- 电子印章图片
- 嵌入式签署者带签名链接
- 字段复选框
- 字段提及
- 字段单选按钮组
- 字段单选按钮组单选按钮内部
- 字段只读文本
- 字段签名
- 字段文本
- 字段类型
- 字段输入
- 关注者
- 字体
- 字体家族
- 字体变体
- 从现有联系人
- 从现有联系人1
- 从现有签署者
- 从现有用户
- 从现有用户1
- 从头开始
- 从头开始1
- 从头开始1自定义文本
- 从头开始1信息
- 从头开始1重定向 URL
- 从头开始信息
- 获取联系人 200 响应
- 获取自定义体验 200 响应
- 获取签名请求 200 响应
- 获取签名请求签名请求 ID 文档文档 ID 字段 200 响应
- 获取签名请求签名请求 ID 文档文档 ID 字段 200 响应数据内部
- 获取签名请求签名请求 ID 关注者 200 响应
- 获取签名请求签名请求 ID 签署者签署者 ID 文档 200 响应
- 获取模板 200 响应
- 获取用户 200 响应
- 获取工作区 200 响应
- 首字母区域
- 列出电子印章图片 200 响应
- 区域
- 将工作区标记为默认
- 提及
- 提及1
- 提及2
- 元数据
- 元数据数据值
- OTP 消息
- 分页
- 修补自定义体验徽标请求
- 修补签名请求签名请求 ID 审批者审批者 ID 请求
- 修补签名请求签名请求 ID 审批者审批者 ID 请求信息
- POST 存档 401 响应
- POST 签名请求签名请求 ID 审批者请求
- POST 签名请求签名请求 ID 取消请求
- 发布签名请求签名请求ID文档文档ID替换请求
- 发布签名请求签名请求ID重新激活请求
- 单选按钮组
- 单选按钮组1
- 单选按钮组1单选按钮内部
- 单选按钮组2
- 单选按钮组2单选按钮内部
- 单选按钮组单选按钮内部
- 只读文本
- 只读文本1
- 签名
- 签名1
- 签名2
- 签名请求
- 签名请求已激活
- 签名请求已激活文档内部
- 签名请求拒绝信息
- 签名请求电子邮件通知
- 签名请求电子邮件通知发送者
- 签名请求在列表中
- 签名请求在列表审批者内部
- 签名请求在列表文档内部
- 签名请求在列表提醒设置
- 签名请求在列表发送者
- 签名请求在列表签署者内部
- 签名请求占位符只读文本字段替代输入
- 签名请求占位符签署者替代从联系人ID输入
- 签名请求占位符签署者替代从信息输入
- 签名请求占位符签署者替代从信息输入信息
- 签名请求占位符签署者替代从用户ID输入
- 签名请求签署者从联系人ID输入
- 签名请求签署者从信息输入
- 签名请求签署者从信息输入信息
- 签名请求签署者从信息输入重定向URL
- 签名请求签署者从用户ID输入
- 签名请求状态
- 签署者
- 签署者审计跟踪
- 签署者自定义文本
- 签署者投递模式
- 签署者文档
- 签署者文档请求
- 签署者字段内部
- 签署者信息
- 签署者重定向URL
- 签署者SMTP地址
- 签署者签署
- 签署者使用上传的签名图像签署
- 短信通知
- 短信通知1
- 模板
- 文本
- 文本1
- 文本2
- 更新联系人
- 更新自定义体验
- 更新自定义体验重定向URL
- 更新文档
- 更新字段
- 更新字段字体
- 更新签名请求
- 更新签名请求元数据
- 更新签名请求元数据数据值
- 更新签名请求提醒设置
- 更新签署者
- 更新签署者信息
- 更新Webhook订阅
- 更新工作空间
- 上传归档文件
- 上传电子印章文档
- 上传电子印章图像
- 用户
- 用户工作空间内部
- 违规响应
- Webhook订阅
- Webhook订阅作用域
- Webhook订阅已订阅事件
- Webhook订阅工作空间
- 工作空间
- 工作空间用户内部
授权
为API定义的认证方案
bearerAuth
- 类型:Bearer认证
测试
要运行测试,请使用
composer install vendor/bin/phpunit
作者
关于此包
此PHP包由OpenAPI Generator项目自动生成
- API版本:
3.0
- 生成器版本:
7.8.0
- 生成器版本:
- 构建包:
org.openapitools.codegen.languages.PhpClientCodegen