README

Dropbox Sign v3 API

从旧版SDK迁移

此SDK是从我们官方维护的OpenAPI规范生成的。我们已进行重要更新，引入了新功能，并在Dropbox Sign API和SDK之间创建了功能等效性。然而，其中一些更改被认为是“破坏性的”，这意味着您需要更新现有代码才能继续使用SDK。有关更多信息，请参阅此迁移指南。

贡献

此存储库不再接受新的问题或拉取请求。所有问题或拉取请求必须针对hellosign/hellosign-openapi存储库打开！

SDK代码更改

您必须在templates目录中的mustache文件中进行SDK代码更改，该目录对应于您希望更新的文件。

我们使用OpenAPI Generator通过OAS和模板文件自动生成此SDK。

构建

您必须安装docker（或链接到docker的podman）。强烈建议使用rootless docker。

运行以下命令，一切都将为您完成

./run-build

注意：当您运行此命令时，您对SDK代码所做的任何更改（而未对OAS文件和/或mustache模板文件进行更改）将丢失。

安装与使用

要求

PHP 7.4及更高版本。

Composer

要通过Composer安装绑定，请将以下内容添加到composer.json

{
    "require": {
        "dropbox/sign": "^1.3.0"
    },
    "minimum-stability": "dev"
}

然后运行composer install

或者，直接安装

composer require dropbox/sign:^1.3.0

入门

请按照安装过程进行操作，然后运行以下命令

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$accountApi = new Dropbox\Sign\Api\AccountApi($config);

$data = new Dropbox\Sign\Model\AccountCreateRequest();
$data->setEmailAddress("newuser@dropboxsign.com");

try {
    $result = $accountApi->accountCreate($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

您也可以通过调用类的::init()方法来实例化对象

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");

$api = new Dropbox\Sign\Api\SignatureRequestApi($config);

$data = Dropbox\Sign\Model\SignatureRequestSendRequest::init([
    "title"   => "NDA with Acme Co.",
    "signers" => [
        [
            "email_address" => "jack@example.com",
            "name"          => "Jack",
            "order"         => 0,
        ],
        [
            "email_address" => "jill@example.com",
            "name"          => "Jill",
            "order"         => 1,
        ],
    ],
    "files"    => [
        new SplFileObject("/absolute/path/to/file.pdf"),
    ],
]);

try {
    $result = $api->signatureRequestSend($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling Dropbox Sign API: "
        . $e->getMessage() . PHP_EOL;
}

API端点

所有URI都相对于https://api.hellosign.com/v3

模型

授权

api_key

类型：HTTP基本认证

oauth2

类型: 持证人验证 (JWT)

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

apisupport@hellosign.com

关于此包

此PHP包是由OpenAPI Generator项目自动生成的

API版本: 3.0.0
- 包版本: 1.6.1
- 生成器版本: 7.8.0
构建包: org.openapitools.codegen.languages.PhpClientCodegen

dropbox / sign

维护者

详细信息