docspring / docspring
DocSpring is a service that helps you fill out and sign PDF templates.
Installs: 15 828
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 7
Open Issues: 1
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
DocSpring is a service that helps you fill out and sign PDF templates.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/docspring/docspring.git" } ], "require": { "docspring/docspring": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/DocSpring/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?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 $data = new \DocSpring\Model\AddFieldsData(); // \DocSpring\Model\AddFieldsData try { $result = $apiInstance->addFieldsToTemplate($template_id, $data); print_r($result); } catch (Exception $e) { echo 'Exception when calling PDFApi->addFieldsToTemplate: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.docspring.com/api/v1
Models
- AddFieldsData
- AddFieldsTemplateResponse
- AuthenticationError
- AuthenticationSuccessResponse
- CombinePdfsData
- CombinedSubmission
- CombinedSubmissionAction
- CombinedSubmissionData
- CopyTemplateData
- CreateCombinedSubmissionResponse
- CreateCustomFileData
- CreateCustomFileResponse
- CreateFolderAttributes
- CreateFolderData
- CreateHtmlTemplateData
- CreateSubmissionBatchResponse
- CreateSubmissionBatchSubmissionsResponse
- CreateSubmissionData
- CreateSubmissionDataRequestData
- CreateSubmissionDataRequestTokenResponse
- CreateSubmissionResponse
- CreateTemplateFromUploadData
- DataRequestToken
- DeleteTemplateResponse
- ErrorResponse
- Folder
- FullTemplate
- HtmlTemplateData
- InvalidRequest
- ListSubmissionsResponse
- MoveFolderData
- MoveTemplateData
- PendingTemplate
- RenameFolderData
- Submission
- SubmissionAction
- SubmissionBatch
- SubmissionBatchData
- SubmissionData
- SubmissionDataBatchRequest
- SubmissionDataRequest
- Template
- TemplateData
- TemplateDefaults
- TemplateDocument
- TemplateDocumentMetadata
- UpdateDataRequestResponse
- UpdateSubmissionDataRequestData
- UpdateTemplateData
- UpdateTemplateResponse
- UploadTemplateData
Authorization
Authentication schemes defined for the API:
api_token_basic
- Type: HTTP basic authentication
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
v1
- Package version:
2.0.0
- Package version:
- Build package:
com.docspring.codegen.DocSpringPhpClientCodegen