postivo/postivo-client

v0.0.37 2025-10-16 10:39 UTC

Requires

• php: >=8.2
• brick/date-time: >=0.7.0
• brick/math: >=0.12.1
• galbar/jsonpath: >=3.0
• guzzlehttp/guzzle: ^7.0
• phpdocumentor/type-resolver: >=1.8
• speakeasy/serializer: ^4.0.3

Requires (Dev)

• laravel/pint: >=1.21.2
• phpstan/phpstan: >=2.1.0
• phpunit/phpunit: >=10
• roave/security-advisories: dev-latest

MIT

README

POSTIVO.PL REST API Client SDK for PHP ≥ 8.2 (postivo/postivo-client)

This package provides the POSTIVO.PL Hybrid Mail Services SDK for PHP (≥ 8.2), allowing you to dispatch shipments directly from your application via the POSTIVO.PL platform.

Additional documentation:

Comprehensive documentation of all methods and types is available below in Available Resources and Operations.

You can also refer to the REST API v1 documentation for additional details about this SDK.

Table of Contents

• POSTIVO.PL REST API Client SDK for PHP ≥ 8.2 (postivo/postivo-client)
  • Additional documentation:
  • SDK Installation
  • Requirements:
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK relies on Composer to manage its dependencies.

To install the SDK and add it as a dependency to an existing composer.json file:

composer require "postivo/postivo-client"

Requirements:

• Minimal required PHP version: 8.2

SDK Example Usage

Sending Shipment to single recipient

This example demonstrates simple sending Shipment to a single recipient:

declare(strict_types=1);

require 'vendor/autoload.php';

use Brick\DateTime\LocalDate;
use Postivo;
use Postivo\Models\Components;

$sdk = Postivo\Client::builder()
    ->setSecurity(
        '<YOUR API ACCESS TOKEN>'
    )
    ->build();

$request = new Components\Shipment(
    recipients: new Components\RecipientInline(
        name: 'Jan Nowak',
        name2: 'Firma testowa Sp. z o.o.',
        address: 'ul. Testowa',
        homeNumber: '23',
        flatNumber: '2',
        postCode: '00-999',
        city: 'Warszawa',
        phoneNumber: '[phone]',
        postscript: 'Komunikat',
        customId: '1234567890',
    ),
    documents: [
        new Components\DocumentPdf(
            fileStream: '<document_1 content encoded to base64>',
            fileName: 'document1.pdf',
        ),
        new Components\DocumentPdf(
            fileStream: '<document_2 content encoded to base64>',
            fileName: 'document2.pdf',
        ),
    ],
    options: new Components\ShipmentOptions(
        predefinedConfigId: 2670,
    ),
);

$response = $sdk->shipments->dispatch(
    request: $request
);

if ($response->shipmentDetails !== null) {
    // handle response
}

Checking the price of a shipment for single recipient

This example demonstrates simple checking the price of a Shipment to a single recipient:

declare(strict_types=1);

require 'vendor/autoload.php';

use Brick\DateTime\LocalDate;
use Postivo;
use Postivo\Models\Components;

$sdk = Postivo\Client::builder()
    ->setSecurity(
        '<YOUR API ACCESS TOKEN>'
    )
    ->build();

$request = new Components\Shipment(
    recipients: new Components\RecipientInline(
        name: 'Jan Nowak',
        name2: 'Firma testowa Sp. z o.o.',
        address: 'ul. Testowa',
        homeNumber: '23',
        flatNumber: '2',
        postCode: '00-999',
        city: 'Warszawa',
        phoneNumber: '[phone]',
        postscript: 'Komunikat',
        customId: '1234567890',
    ),
    documents: [
        new Components\DocumentPdf(
            fileStream: '<document_1 content encoded to base64>',
            fileName: 'document1.pdf',
        ),
        new Components\DocumentPdf(
            fileStream: '<document_2 content encoded to base64>',
            fileName: 'document2.pdf',
        ),
    ],
    options: new Components\ShipmentOptions(
        predefinedConfigId: 2670,
    ),
);

$response = $sdk->shipments->price(
    request: $request
);

if ($response->shipmentPrices !== null) {
    // handle response
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
bearer	http	HTTP Bearer

To authenticate with the API the bearer parameter must be set when initializing the SDK. For example:

declare(strict_types=1);

require 'vendor/autoload.php';

use Postivo;

$sdk = Postivo\Client::builder()
    ->setSecurity(
        '<YOUR API ACCESS TOKEN>'
    )
    ->build();



$response = $sdk->accounts->get(

);

if ($response->accountResponse !== null) {
    // handle response
}

Available Resources and Operations

Available methods

accounts

• get - Retrieve account details
• getSubaccount - Get subaccount details

addressBook->contacts

• list - List contacts
• add - Add a new contact
• get - Retrieve contact details
• update - Update a contact
• delete - Delete a contact
• removeFromGroup - Remove a contact from a group
• addToGroup - Add a contact to a group

addressBook->contacts->byExtId

• get - Retrieve contact details by EXT_ID
• update - Update a contact by EXT_ID
• delete - Delete a contact by EXT_ID
• removeFromGroup - Remove a contact from a group by EXT_ID
• addToGroup - Add a contact to a group by EXT_ID

addressBook->groups

• list - List groups
• add - Add a new group
• get - Retrieve group details
• update - Update a group
• delete - Delete a group

common

• ping - Check API availability and version

metadata

• list - List metadata
• getPredefinedConfigs - List predefined configs

senders

• list - List senders
• add - Add a new sender
• delete - Delete a sender
• verify - Verify sender

shipments

• status - Retrieve shipment details with status events
• cancel - Cancel shipments
• dispatch - Dispatch a new shipment
• documents - Retrieve documents related to a shipment
• price - Check the shipment price

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide an Options object built with a RetryConfig object to the call:

declare(strict_types=1);

require 'vendor/autoload.php';

use Postivo;
use Postivo\Utils\Retry;

$sdk = Postivo\Client::builder()
    ->setSecurity(
        '<YOUR API ACCESS TOKEN>'
    )
    ->build();



$response = $sdk->accounts->get(
    options: Utils\Options->builder()->setRetryConfig(
        new Retry\RetryConfigBackoff(
            initialInterval: 1,
            maxInterval:     50,
            exponent:        1.1,
            maxElapsedTime:  100,
            retryConnectionErrors: false,
        ))->build()
);

if ($response->accountResponse !== null) {
    // handle response
}

If you'd like to override the default retry strategy for all operations that support retries, you can pass a RetryConfig object to the SDKBuilder->setRetryConfig function when initializing the SDK:

declare(strict_types=1);

require 'vendor/autoload.php';

use Postivo;
use Postivo\Utils\Retry;

$sdk = Postivo\Client::builder()
    ->setRetryConfig(
        new Retry\RetryConfigBackoff(
            initialInterval: 1,
            maxInterval:     50,
            exponent:        1.1,
            maxElapsedTime:  100,
            retryConnectionErrors: false,
        )
  )
    ->setSecurity(
        '<YOUR API ACCESS TOKEN>'
    )
    ->build();



$response = $sdk->accounts->get(

);

if ($response->accountResponse !== null) {
    // handle response
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default an API error will raise a Errors\APIException exception, which has the following properties:

Property	Type	Description
$message	string	The error message
$statusCode	int	The HTTP status code
$rawResponse	?\Psr\Http\Message\ResponseInterface	The raw HTTP response
$body	string	The response content

When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the get method throws the following exceptions:

Error Type	Status Code	Content Type
Errors\ErrorResponse	401, 403, 4XX	application/problem+json
Errors\ErrorResponse	5XX	application/problem+json

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use Postivo;
use Postivo\Models\Errors;

$sdk = Postivo\Client::builder()
    ->setSecurity(
        '<YOUR API ACCESS TOKEN>'
    )
    ->build();

try {
    $response = $sdk->accounts->get(

    );

    if ($response->accountResponse !== null) {
        // handle response
    }
} catch (Errors\ErrorResponseThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\ErrorResponseThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\APIException $e) {
    // handle default exception
    throw $e;
}

Server Selection

Select Server by Name

You can override the default server globally using the setServer(string $serverName) builder method when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Name	Server	Description
prod	https://api.postivo.pl/rest/v1	Production system
sandbox	https://api.postivo.pl/rest-sandbox/v1	Test system (SANDBOX)

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use Postivo;

$sdk = Postivo\Client::builder()
    ->setServer('sandbox')
    ->setSecurity(
        '<YOUR API ACCESS TOKEN>'
    )
    ->build();



$response = $sdk->accounts->get(

);

if ($response->accountResponse !== null) {
    // handle response
}

Override Server URL Per-Client

The default server can also be overridden globally using the setServerUrl(string $serverUrl) builder method when initializing the SDK client instance. For example:

declare(strict_types=1);

require 'vendor/autoload.php';

use Postivo;

$sdk = Postivo\Client::builder()
    ->setServerURL('https://api.postivo.pl/rest/v1')
    ->setSecurity(
        '<YOUR API ACCESS TOKEN>'
    )
    ->build();



$response = $sdk->accounts->get(

);

if ($response->accountResponse !== null) {
    // handle response
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.