pdffiller/pdffiller-php-api-client

PHP client for pdffiller.com REST API

Tuesday, November 14, 2017
by pdffiller
Repository
16 Watchers
12 Stars
13,373 Installations

PHP
0 Dependents
0 Suggesters
5 Forks
1 Open issues
35 Versions
1 % Grown

The README.md

PDFfiller PHP Client

, _(*1)

PDFfiller API You can sign up for the API here, _(*2)

System Requirements

PHP >= 7.0 but the latest stable version of PHP is recommended;
mbstring extension;
intl extension;

Installation

The library is available on Packagist and can be installed using Composer. This is done by running the following command on a composer installed box:, _(*3)

$ composer require pdffiller/pdffiller-php-api-client

Most modern frameworks include Composer out of the box. However, please ensure that the following file is included:, _(*4)

// Include the Composer autoloader
require 'vendor/autoload.php';

Troubleshooting

If you have the following error:, _(*5)

[RuntimeException]
 Could not load package pdffiller/pdffiller-php-api-client in http://packagi
 st.org: [UnexpectedValueException] Could not parse version constraint ^5.2:
  Invalid version string "^5.2"


 [UnexpectedValueException]
 Could not parse version constraint ^5.2: Invalid version string "^5.2"

Try running, _(*6)

composer self-update

Also you might encounter the following:, _(*7)

Warning: require_once(../../vendor/autoload.php): failed to open stream: No such file or directory

This issue is easily fixed by installing composer dependencies:, _(*8)

composer install

Quick getting started steps

Install required libraries using composer, _(*9)

cd pdffiller-php-api-client/
composer install

Edit .env file in examples directory setting client_id, client_secret, username and password (for authorization via password_grant), _(*10)

cd examples/ 
cp .env.example .env
vi .env

Run any example, _(*11)

cd signature_request/
php 1_get_signature_request_list.php

Authentication

Access tokens automatically initialize when they’re successfully retrieved from the given user's credentials (after PDFfiller\OAuth2\Client\Provider\PDFfiller::getAccessToken($grant_type, $options) method), according to the example below:, _(*12)

<?php
require_once __DIR__.'/vendor/autoload.php';

use \PDFfiller\OAuth2\Client\Provider\Enums\GrantType;
use \PDFfiller\OAuth2\Client\Provider\PDFfiller;

$oauthParams = [
    'clientId'       => 'YOUR_CLIENT_ID',
    'clientSecret'   => 'YOUR_CLIENT_SECRET',
    'urlAccessToken' => 'https://api.pdffiller.com/v2/oauth/token',
    'urlApiDomain'   => 'https://api.pdffiller.com/v2/'
];

$passwordGrantCredentials = [
    'username' => 'pdffiller_account@example.com',
    'password' => 'some_pass'
];

/** @var \PDFfiller\OAuth2\Client\Provider\PDFfiller $provider */
$provider = new PDFfiller($oauthParams);

$accessToken = $provider->getAccessToken(GrantType::PASSWORD_GRANT, $passwordGrantCredentials);
print_r($accessToken);

When your authorization has been completed successfully you can use the provider for retrieving, creating, updating or deleting information from your profile., _(*13)

Usage

Use a static method to retrieve a list of all applications: PDFfiller\OAuth2\Client\Provider\Core\Model::all(PDFfiller $provider), _(*14)

$list = Application::all($provider);
print_r($list);

For retrieving information about one application, call static: PDFfiller\OAuth2\Client\Provider\Core\Model::one(PDFfiller $provider, $appClientId), _(*15)

$application = Application::one($provider, 'app_client_id');
print_r($application);

If you want to create a new application, you must create a new Application object with the necessary information and save it using the following method: PDFfiller\OAuth2\Client\Provider\Core\Model::save(), _(*16)

$application = new Application($provider);

$application->name = 'App name';
$application->description = 'Some application description';
$application->domain = 'http://some.domain.com';
print_r($application->save());

If you want to update an instance, you must retrieve an Application object and save it by using the following method: PDFfiller\OAuth2\Client\Provider\Core\Model::save(), _(*17)

$application = Application::one($provider, 'app_client_id');

$application->name = 'Updated App name';
$application->description = 'Some changed application description';
$result = $application->save();
print_r($result);

Updating information is easy by using: PDFfiller\OAuth2\Client\Provider\Core\Model::save() method. If you wish to remove an application, use: PDFfiller\OAuth2\Client\Provider\Core\Model::remove() method, _(*18)

$application = Application::one($provider, 'app_client_id');
$result = $application->remove();
print_r($result);

All examples with other endpoints are available in the examples folder, _(*19)

Support

If you have any problems feel free to contact us: * On our issues page https://github.com/pdffiller/pdffiller-php-api-client/issues * Via chat or phone at our tech site http://developers.pdffiller.com * Join our Gitter chat room for technical advice https://gitter.im/pdffiller/pdffiller-php-api-client, _(*20)

License

This software is licensed under the following MIT license, _(*21)

Author

API Team (integrations@pdffiller.com), _(*22)

The Versions

14/11 2017

dev-feature/AC-664_add_v2_oauth_and_template_crud

PHP client for pdffiller.com REST API

library pdffiller-php-api-client

PHP client for pdffiller.com REST API

pdffiller/pdffiller-php-api-client

The README.md

PDFfiller PHP Client

System Requirements

Installation

Troubleshooting

Quick getting started steps

Authentication

Usage

Support

License

Author

The Versions

dev-feature/AC-664_add_v2_oauth_and_template_crud

The Requires

The Development Requires

by API Team

dev-master

The Requires

The Development Requires

by API Team

2.2.2

The Requires

The Development Requires

by API Team

2.0.x-dev

The Requires

The Development Requires

by API Team

2.2.1

The Requires

The Development Requires

by API Team

2.2.0

The Requires

The Development Requires

by API Team

2.1.0

The Requires

The Development Requires

by API Team

dev-feature/API-1976-fillable-field-property-fillable

The Requires

The Development Requires

by API Team

dev-feature/API-1854-fill-request-endpoints

The Requires

The Development Requires

by API Team

2.0.1

The Requires

The Development Requires

by API Team

dev-fix/API-1852-fix-filled-form-export

The Requires

The Development Requires

by API Team

dev-fix/API-1837-fil-losing-l2f-additional-documents

The Requires

The Development Requires

by API Team

dev-fix/API-1836-add-application-fields

The Requires

The Development Requires

by API Team

dev-feature/API-1827-fix-fillable-fields

The Requires

The Development Requires

by API Team

1.6.x-dev

The Requires

The Development Requires

1.6.2

The Requires

The Development Requires

1.6.1

The Requires

The Development Requires