tigron/peppyrus-api-php

There is no license information available for the latest version (dev-main) of this package.

Peppyrus PHP API client

dev-main 2025-06-12 10:42 UTC

Requires

• php: >=7.4
• ext-curl: *
• ext-json: *
• ext-openssl: *
• guzzlehttp/guzzle: ^7.6

Unknown License

• Tigron B.V.

• php
• ubl
• peppol
• Peppyrus

README

Requirements

To use Peppyrus API client, the following things are required:

• Create a free Peppyrus account
• Register your Participant ID
• PHP >= 7.4
• cUrl >= 7.19.4

Installation

via composer:

composer require tigron/peppyrus-api-php

Howto

Authentication

Make sure you set the API key:

\Peppyrus\Api\Config::$key = 'YOUR_API_KEY';

Peppol search operations

Lookup participant capabilities in SMP. This will return a list of document types that are supported by the participant.

$response = Peppyrus\Api\Peppol::lookup('iso6523-actorid-upis', '9925:be0886776275');

Search a Participant in the Peppol directory based on search parameters.

$parameters = [ 'query' => 'peppyrus' ];
$response = Peppyrus\Api\Peppol::search($parameters);

The following parameters are available:

| parameter 	| Description					|
| ---------		| -----------					|
| query			| Generic query term			|
| participantId	| Searches for exact matches in the Peppol participant identifier field (the identifier scheme must be part of the value)|
| name			| Searches for partial matches in business entity names		|
| country		| Searches for exact matches in business entity country codes (ISO-2 code)	|
| geoInfo		| Searches for partial matches in the geographical information			|
| identifierScheme			| Searches for exact matches in the additional identifier schemes. Combine it with identifierValue for fine grained search results.		|
| identifierValue			| Searches for exact matches in the additional identifier values. Combine it with identifierScheme for fine grained search results.		|
| contact		| Searches for partial matches in the business entity contact information. It searches in all sub-fields of contact (type, name, phone number and email address).|