meioco3 / docspring
2.3.3
2023-09-26 07:00 UTC
Requires
- php: >=5.6
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.8
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
README
DocSpring 是一款帮助您填写和签署 PDF 模板的服务。
此 PHP 包由 OpenAPI Generator 项目自动生成
- API 版本:v1
- 包版本:1.3.2
- 构建包:com.docspring.codegen.DocSpringPhpClientCodegen
要求
PHP 5.5 及以上版本
安装与使用
Composer
要通过 Composer 安装绑定,请将以下内容添加到 composer.json
{
"repositories": [
{
"type": "git",
"url": "https://github.com/docspring/docspring.git"
}
],
"require": {
"docspring/docspring": "*@dev"
}
}
然后运行 composer install
手动安装
下载文件并包含 autoload.php
require_once('/path/to/DocSpring/vendor/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门指南
请按照 安装过程 进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: api_token_basic $config = DocSpring\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new DocSpring\Api\PDFApi( // 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 ); $template_id = tpl_000000000000000002; // string | $add_fields_data = new \DocSpring\Model\AddFieldsData(); // \DocSpring\Model\AddFieldsData | try { $result = $apiInstance->addFieldsToTemplate($template_id, $add_fields_data); print_r($result); } catch (Exception $e) { echo 'Exception when calling PDFApi->addFieldsToTemplate: ', $e->getMessage(), PHP_EOL; } ?>
API 端点文档
所有 URI 都相对于 https://api.docspring.com/api/v1
模型文档
- 添加字段数据
- 添加字段模板响应
- 认证错误
- 认证成功响应
- 合并 PDF 数据
- 合并提交
- 合并提交操作
- 合并提交数据
- 复制模板数据
- 创建合并提交响应
- 创建自定义文件数据
- 创建自定义文件响应
- 创建文件夹数据
- 创建 HTML 模板数据
- 创建提交批量响应
- 创建提交批量提交响应
- 创建提交数据请求数据
- 创建提交数据请求令牌响应
- 创建提交数据请求令牌响应令牌
- 创建提交响应
- 从上传创建模板
- 自定义文件
- 错误
- 文件夹
- 文件夹文件夹
- 完整模板
- 完整模板默认值
- HTML 模板数据
- 无效请求
- 提交列表响应
- 移动文件夹数据
- 移动模板数据
- 挂起的模板
- 重命名文件夹数据
- 提交
- 提交操作
- 提交批量
- 提交批量数据
- 提交数据
- 提交数据批量请求
- 提交数据请求
- 模板
- 模板数据
- 模板stemplateIdaddFieldsFields
- 更新数据请求响应
- 更新提交数据请求数据
- 更新模板数据
- 更新模板响应
- 上传模板数据
- 上传模板数据文档
- 上传模板数据文档元数据
授权文档
api_token_basic
- 类型:HTTP 基本认证