yuramozol/com.docstudio.api.php-client

DocStudio API 客户端

维护者

详细信息

github.com/jecksolovyev/com.docstudio.api.php-client

源代码

问题

安装: 11

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 1

开放问题: 0

v110.4 2024-07-22 14:19 UTC

Requires

Requires (Dev)

MIT 290b10166348d248329ead933cbfb38694c4ea85

  • Developers Team

This package is auto-updated.

Last update: 2024-10-02 15:00:24 UTC

README

此 PHP 包是由 Swagger Codegen 项目自动生成的

  • API 版本：R110.5
  • 构建包：io.swagger.codegen.v3.generators.php.PhpClientCodegen

要求

PHP 7.4 及以上

安装与使用

Composer

要通过 Composer 安装绑定，请执行以下操作

composer require jecksolovyev/com.docstudio.api.php-client

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门指南

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

<?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    use DocStudio\Client\ApiException;
    use DocStudio\Client\Configuration;
    use DocStudio\Client\Model\LoginDTO;
    use DocStudio\Client\Model\QuickSendDTO;
    use DocStudio\Client\Model\QuickSendRecipientDTO;
    use DocStudio\Client\Api\EnvelopeControllerApi;
    use DocStudio\Client\Api\AuthenticationControllerApi;
    
    
    $httpClient = new GuzzleHttp\Client([
            'timeout' => 30,
            'connect_timeout' => 30,
            'read_timeout' => 30
        ]
    );
    
    $username = 'my@email.com';
    $password = 'password';
    
    $loginController = new AuthenticationControllerApi($httpClient);
    
    $token = $loginController->login((new LoginDTO())->setLogin($username)->setPassword($password))->getToken();
    
    echo 'Token: ' . $token . PHP_EOL;
    
    $configuration = new Configuration();
    $configuration->setUserAgent('Demo integration')->setAccessToken($token);
    
    $mailboxController = new DocStudio\Client\Api\MailboxControllerApi($httpClient, $configuration);
    $mailboxUuid = $mailboxController->getAllForUser()[0]->getMailboxUuid();
    $envelopeController = new EnvelopeControllerApi($httpClient, $configuration);
    
    $quickSendRequest = new QuickSendDTO();
    $quickSendRequest->setSubject('Test envelope')->setMessage('Test envelope message');
    $sender = new QuickSendRecipientDTO();
    $recipients = [];
    $sender->setRecipient($mailboxUuid)->setSigner(true)->setEInkSignature(true);
    $recipients[] = $sender;
    $recipient = new QuickSendRecipientDTO();
    $recipient->setRecipient('wife@family.com')->setSigner(true)->setEInkSignature(true);
    $recipients[] = $recipient;
    $quickSendRequest->setRecipients($recipients);

    $envelopeController->quickSendExternalDocuments(['/app/sample.pdf', '/app/sample2.pdf'], $quickSendRequest, $mailboxUuid);

API 端点

所有 URI 都是相对于 https://api.docstudio.com

模型