pingencom/pingen2-sdk-php

Official PHP Pingen SDK for API V2

2.13.0 2024-10-03 09:33 UTC

Requires

• php: ^8.1|^8.2|^8.3
• ext-json: *
• illuminate/http: ^10.0|^11.0
• illuminate/support: ^10.0|^11.0
• league/oauth2-client: ^2.6

Requires (Dev)

• mockery/mockery: ^1.4
• nikic/php-parser: 4.15.*
• php-parallel-lint/php-parallel-lint: ^1.2
• phpstan/phpstan: ^1.4
• phpunit/phpunit: ^10.5|^11.0
• rector/rector: ^0.12.16
• symplify/easy-coding-standard-prefixed: 9.2.6

BSD-3-Clause

• Pingen GmbH

README

You need to have an account in pingen v2 and obtain oauth credentials for your desired grant type (usually client_credentials).

How to obtain these are described here: https://api.pingen.com/documentation#section/Authentication/How-to-obtain-a-Client-ID

Installation

Require the package via composer (Get composer here: https://getcomposer.org/download/)

composer require pingencom/pingen2-sdk-php

Environments

We have two Environments available: Production and Staging (see https://api.pingen.com/documentation#section/Basics/Environments)

This SDK supports staging as well. When initiating the provider (see Usage), the optional 'staging' attribute should be set, as well as when creating an endpoint object.

Usage

The simplest way to integrate is using the client credentials grant (see https://api.pingen.com/documentation#section/Authentication/Which-grant-type-should-i-use)

require __DIR__ . '/vendor/autoload.php';

$provider = new \Pingen\Provider\Pingen(
    array(
        'clientId' => 'YOUR_OAUTH2_CLIENT_ID',
        'clientSecret' => 'YOUR_OAUTH2_CLIENT_SECRET',
        'staging' => true,
    )
);

$access_token = $provider->getAccessToken('client_credentials');

$lettersEndpoint = (new \Pingen\Endpoints\LettersEndpoint($access_token))
    ->setOrganisationId('INSERT_YOUR_ORGANISATION_UUID_HERE')
    ->useStaging();

$lettersEndpoint->uploadAndCreate(
    (new \Pingen\Endpoints\DataTransferObjects\Letter\LetterCreateAttributes())
        ->setFileOriginalName('your_original_pdf_name.pdf')
        ->setAddressPosition('left')
        ->setAutoSend(false),
    fopen('path_to_your_original_pdf_name.pdf', 'r')
);

Examples & Docs

Our API Docs are here: https://api.pingen.com/documentation

On the right-hand side of every endpoint you can see request samples for PHP and other languages, which you can copy and paste into your application.

Bugreport & Contribution

If you find a bug, please either create a ticket in github, or initiate a pull request.

Versioning

We adhere to semantic (major.minor.patch) versioning (https://semver.org/). This means that:

• Patch (x.x.patch) versions fix bugs
• Minor (x.minor.x) versions introduce new, backwards compatible features or improve existing code.
• Major (major.x.x) versions introduce radical changes which are not backwards compatible.

In your automation or procedure you can always safely update patch & minor versions without the risk of your application failing.

Testing

PHPUnit: vendor/bin/phpunit

ECS: vendor/bin/ecs check src

PHPStan: vendor/bin/phpstan analyse -c phpstan.neon --memory-limit=512M

Lint: vendor/bin/parallel-lint --exclude vendor .