signiflow / connect-php-sdk
## SigniFlow API 用于自动化电子签名工作流创建和管理。
1.0.1
2021-07-13 07:09 UTC
Requires
- php: >=7.2
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: >=6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.12
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-09-13 14:09:19 UTC
README
SigniFlow/connect-php-sdk - 用于 SigniFlow OpenAPI Spec v1 的 PHP 库
SigniFlow API 用于自动化电子签名工作流创建和管理。
有关更多信息,请访问 https://www.signiflow.com/contact.
安装与使用
要求
PHP 7.2 及更高版本。
Composer
要通过 Composer 安装绑定,请将以下内容添加到 composer.json
{ "repositories": [ { "type": "vcs", "url": "https://github.com/signiflow/connect-php-sdk.git" } ], "require": { "signiflow/connect-php-sdk": ">=1.0.1*" } }
然后运行 composer install
手动安装
下载文件并包含 autoload.php
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
入门
请按照 安装过程 进行操作,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); $config = new SigniFlowConnect\Configuration(); $config->setHost('https://Server-Url/API/SignFlowAPIServiceRest.svc'); $apiInstance = new SigniFlowConnect\Api\AuditsApi( // 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 ); $content_type = 'application/json' $get_audit_document_request = json_decode('{"DocIDField":"string","TokenField":{"TokenExpiryField":"2019-08-24T14:15:22Z","TokenField":"aaa111"}}') // \SigniFlowConnect\Model\GetAuditDocumentRequest | ##### Get Audit Document Request Model try { $result = $apiInstance->postGetAuditDocument($content_type, $get_audit_document_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling AuditsApi->postGetAuditDocument: ', $e->getMessage(), PHP_EOL; }
API 端点
所有 URI 都相对于 https://server-url/API/SignFlowAPIServiceRest.svc
模型
- ActionField
- AddWokflowStepV2Response
- AddWokflowStepV2ResponseFlowStepsField
- AddWorkflowStepV2Request
- AdvancedFieldType
- ApplyPrepperTemplateRequest
- ApplyPrepperTemplateResponse
- AutoExpire
- AutoRemind
- CancelFlowRequest
- CancelFlowResponse
- CreatePortfolioRequest
- CreatePortfolioResponse
- CreateWorkflowRequest
- CreateWorkflowResponse
- DeleteDocRequest
- DeleteDocResponse
- DocExtension
- DocPrepperAddAdvancedFieldsRequest
- DocPrepperAddAdvancedFieldsRequestFieldInfoListField
- DocPrepperAddAdvancedFieldsRequestFieldOptionsListField
- DocPrepperAddAdvancedFieldsResponse
- DocPrepperAddAdvancedFieldsResponseAdvancedFieldResponseListField
- DocPrepperAddFieldsFlowIDRequest
- DocPrepperAddFieldsFlowIDResponse
- DownloadPortfolioRequest
- DownloadPortfolioResponse
- FieldType
- FullWorkflowRequest
- FullWorkflowRequestGroupStepField
- FullWorkflowRequestGroupStepFieldGroupMembersField
- FullWorkflowRequestPortfolioInformationField
- FullWorkflowRequestWorkflowUserFieldsField
- FullWorkflowRequestWorkflowUsersListField
- FullWorkflowResponse
- GetAuditDocumentRequest
- GetAuditDocumentResponse
- GetDocLinkRequest
- GetDocLinkResponse
- GetDocStatusRequest
- GetDocStatusResponse
- GetDocumentAuditRequest
- GetDocumentAuditResponse
- GetDocumentAuditResponseActivityField
- GetDocumentPrepperLinkRequest
- GetDocumentPrepperLinkResponse
- GetDocumentRequest
- GetDocumentResponse
- GetDocumentTagFieldBoxPositionRequest
- GetDocumentTagFieldBoxPositionResponse
- GetDocumentTagFieldBoxPositionResponseDocumentTagFieldsBoxPositionField
- GetDocumentTagFieldPositionRequest
- GetDocumentTagFieldPositionResponse
- GetDocumentTagFieldPositionResponseDocumentTagFieldsPositionField
- GetPrepperTemplateListRequest
- GetPrepperTemplateListResponse
- GetPrepperTemplateListResponseTemplateInformationValuesField
- GetPrepperTemplateRequest
- GetPrepperTemplateResponse
- GetPrepperTemplateResponsePrepperTemplateValuesField
- InitiateFlowNoEmailRequest
- InitiateFlowNoEmailResponse
- InitiateFlowNoInitialEmailRequest
- InitiateFlowNoInitialEmailResponse
- InitiateFlowRequest
- InitiateFlowResponse
- LinkToPortfolioRequest
- LinkToPortfolioResponse
- LoginRequest
- LoginResponse
- LogoutRequest
- LogoutResponse
- MultipleSignersSigningCeremonyRequest
- MultipleSignersSigningCeremonyRequestSignerListField
- MultipleSignersSigningCeremonyResponse
- Priority
- ProxyAllowedField
- SetDocumentOrderRequest
- SetDocumentOrderResponse
- SharePortfolioNoEmailRequest
- SharePortfolioNoEmailResponse
- SharePortfolioRequest
- SharePortfolioResponse
- SigningCeremonyV2Request
- SigningCeremonyV2Response
- TokenExtendRequest
- TokenExtendResponse
- TokenField
- TokenValidateRequest
- TokenValidateResponse
- WorkflowSignRequest
- WorkflowSignResponse
授权
所有端点均不需要授权。
测试
要运行测试,请使用
composer install vendor/bin/phpunit
作者
关于此包
此PHP包由OpenAPI Generator项目自动生成
- API版本:
1.0
- 包版本:
1.0.1
- 包版本:
- 构建包:
org.openapitools.codegen.languages.PhpClientCodegen
贡献
请将错误报告、功能请求和代码贡献发送到API规范存储库,因为此存储库仅包含生成的SDK代码。
许可证
Copyright 2021 SigniFlow, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://apache.ac.cn/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.