Download the PHP package n1ebieski/ksef-php-client without Composer
On this page you can find all versions of the php package n1ebieski/ksef-php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download n1ebieski/ksef-php-client
More information about n1ebieski/ksef-php-client
Files in n1ebieski/ksef-php-client
Package ksef-php-client
Short Description PHP API client that allows you to interact with the API Krajowego Systemu e-Faktur
License MIT
Informations about the package ksef-php-client
KSEF PHP Client
This package is not production ready yet!
PHP API client that allows you to interact with the API Krajowego Systemu e-Faktur
Table of Contents
- Get Started
- Client configuration
- Auto mapping
- Authorization
- Auto authorization via API Token
- Auto authorization via certificate .p12
- Manual authorization
- Resources
- Common
- Status
- Online
- Session
- Authorisation challenge
- Init token
- Init signed
- Session status
- Terminate
- Invoice
- Get an invoice
- Send an invoice
- Invoice status
- Query
- Invoice
- Sync
- Async
- Fetch init
- Fetch status
- Fetch invoices
- Invoice
- Session
- Common
- Examples
- Send an invoice and check for UPO
- Fetch invoices using encryption key
- Testing
- Roadmap
- Special thanks
Get Started
Requires PHP 8.4+
First, install ksef-php-client
via the Composer package manager:
Ensure that the php-http/discovery
composer plugin is allowed to run or install a client manually if your project does not already have a PSR-18 client integrated.
Client configuration
Auto mapping
Each resource supports mapping through both an array and a DTO, for example:
or:
Authorization
Auto authorization via API Token
Auto authorization via certificate .p12
Manual authorization
Resources
Common
Status
Checking the status of batch processing (with UPO after finalization)
Online
Session
Authorisation challenge
Initialize the authentication and authorization mechanism.
Init token
Initializing an interactive session. KSeF public key encrypted document http://ksef.mf.gov.pl/schema/gtw/svc/online/auth/request/2021/10/01/0001/InitSessionTokenRequest
Init signed
Initializing an interactive session. Signed document http://ksef.mf.gov.pl/schema/gtw/svc/online/auth/request/2021/10/01/0001/InitSessionSignedRequest
or:
Session status
Checking the status of current interactive processing or based on the reference number.
Terminate
Forcing the closing of an active interactive session
Invoice
Get an invoice
Invoice download.
Send an invoice
Invoice status
Checking the status of a sent invoice.
Query
Invoice
Sync
Search and filter invoices
Async
Fetch init
Initialization of invoice fetch request
Fetch status
Checking the status of invoice fetch request
Fetch invoices
Downloading invoice query results
Examples
Send an invoice and check for UPO
Fetch invoices using encryption key
Testing
The package uses unit tests via PHPUnit.
TestCase is located in the location of
Fake request and responses fixtures for resources are located in the location of
Run all tests:
Roadmap
- Batch endpoints
- Prepare the package for release candidate
Special thanks
Special thanks to:
- all the helpful people on the 4programmers.net forum
- authors of the repository grafinet/xades-tools for the Xades document signing tool
All versions of ksef-php-client with dependencies
php-http/discovery Version ^1.20.0
psr/http-client Version ^1.0.3
psr/http-client-implementation Version ^1.0.1
psr/http-factory-implementation Version *
psr/http-message Version ^1.1.0|^2.0.0
cuyz/valinor Version ^1.15
symfony/uid Version ^7.0
krowinski/bcmath-extended Version ^6.0
psr-discovery/log-implementations Version ^1.1