Download the PHP package signnow/api-php-sdk without Composer
On this page you can find all versions of the php package signnow/api-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package api-php-sdk
SignNow API PHP Client
Simple API Client to integrate SignNow with your application or website. Sign documents, request e-signatures, and build role-based workflows with multiple signers: https://www.signnow.com/developers
Table of Contents
- Requirements
- Install
- Setting up
- Tests
- Sandbox
- Entity manager
- Actions
- Examples & use cases
- OAuth 2.0
- Request Access Token
- Verify Access Token
- Refresh Access Token
- Document
- Upload document
- Upload document with text tags and convert them to fillable fields
- Retrieve document
- Delete document
- Download document
- Modify document name
- Create a single-use link for document downloading
- Create a role-based invite to sign a document
- Create a simple free form invite to sign a document
- Cancel an invite to sign a document
- Create a signing link
- Add fillable fields to a document
- Prefill fillable text fields in a document
- Template
- Create a template
- Generate a document from template (Copy template)
- Document group
- Retrieve document group
- Delete document group
- Cancel document group invite
- Event subscriptions
- Get User Event Subscriptions
- Create User Event Subscription
- Delete User Event Subscription
- Embedded invites
- Create embedded invites
- Create signing link
- Prolong signing link
- Delete embedded invites
- Reassign signers
- User
- OAuth 2.0
PHP 7.1 or newer
Install
Setting up
Register an annotation loader if only there is doctrine/annotations
less v2.0 in use.
This method is deprecated and will be removed in doctrine/annotations 2.0
so
annotations will be autoloaded in 2.0.
Create the instance of Entity Manager:
Setup update http method for Entity Manager:
Also, it is possible to use the wrapper using OAuth authorization
Tests
SignNow PHP SDK is covered with functional tests using Codeception and Phiremock. Phiremock allows us to mock calls to SignNow API. All the calls pass at 127.0.0.1 port 8008. Ensure that this port is not in use in the local machine before running test.
All the tests execution in console:
A single test execution in console:
Also, tests might be useful as examples of using SignNow PHP SDK.
Sandbox
Directory sandbox contains php script to taste some SDK feature. Please, provide this scripts with your personal credentials, write some code or use existing code. Execute sandbox script in console:
Entity manager
Entity manager is the main class which controls communication with 3rd party REST API where JSON is used as main data type. It's responsible for saving objects to and fetching objects from the API.
Each entity is described by:
- API resource url (via HttpEntity annotation),
- API payload (via properties and theirs types),
- API response type (via ResponseType annotation, optional).
Examples & use cases
Upload Document to SignNow
Download Document from SignNow
Actions
Actions - this is just a new abstraction layer above Entity Manager and implemented as services. So that, both Entity Manager and Actions are equivalent options to use SignNow API. See actions in directory src/Action.