Download the PHP package naprawksef/sdk without Composer
On this page you can find all versions of the php package naprawksef/sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download naprawksef/sdk
More information about naprawksef/sdk
Files in naprawksef/sdk
Package sdk
Short Description Official PHP SDK for the NaprawKSeF API (KSeF XML validation, FA(3) correction builder, webhooks). Zero non-stdlib runtime dependencies; works with Laravel, Symfony and plain PHP.
License MIT
Homepage https://naprawksef.pl/developers/sdk-php
Informations about the package sdk
naprawksef/sdk
Official PHP SDK for the NaprawKSeF API.
- Full coverage of
/api/v1: validate, correction analyze, scenarios, webhooks, me, health - Built-in retries (429, 5xx, network), respects
Retry-After - Automatic
Idempotency-Keygeneration for POST requests - Webhook signature verification helper (constant-time HMAC-SHA256)
- Zero runtime dependencies — uses native
ext-curl
Requirements
- PHP 8.1+
- ext-curl
- ext-json
Installation
Quick start
API keys
API keys come in two environments:
| Prefix | Environment | Quota | History |
|---|---|---|---|
nk_live_* |
production | counts against your plan | persisted in dashboard |
nk_test_* |
sandbox | bypassed | not persisted |
The SDK rejects malformed keys at construction time (44 chars, nk_<env>_<4 hex prefix><32 hex secret>).
Idempotency
POSTs to mutating endpoints accept an idempotency key (8–200 chars). The SDK auto-generates a UUID v4 when you don't supply one — pass your own for end-to-end replay safety:
Replays return the original response for 24 hours. Conflicting bodies under
the same key yield an IdempotencyConflictException.
Errors
All API errors are subclasses of NaprawKsefException:
Each exception exposes $status, $code (stable string, e.g.
QUOTA_EXCEEDED), $requestId, $headers and $details.
RateLimitException and IdempotencyConflictException expose
retryAfterSeconds() to make retry loops easy.
Webhooks
Verify incoming events with the standalone helper (no SDK client needed):
Laravel controller:
Retries
408, 425, 429, 500, 502, 503, 504 and network errors are
retried up to max_retries (default 3) with exponential backoff +
±20 % jitter. Retry-After is honoured on 429/503.
Testing
The included PHPUnit suite covers signature verification end-to-end.
License
MIT. See LICENSE.
All versions of sdk with dependencies
ext-curl Version *
ext-json Version *