Referencja API
Referencja API
Wszystkie endpointy w jednym miejscu i konwencje wspólne dla całego API.
Wszystkie endpointy
| Faktury i korekty | |
|---|---|
GET/v1/invoices | Lista faktur |
POST/v1/invoices | Utwórz fakturę z opłaconego zamówienia |
GET/v1/invoices/{id} | Pobierz fakturę lub korektę |
GET/v1/invoices/{id}/pdf | Pobierz PDF |
POST/v1/invoices/{id}/corrections | Utwórz korektę (zwrot) |
| Konto | |
GET/v1/account | Pobierz konto |
| Endpointy webhooków | |
GET/v1/webhook_endpoints | Lista endpointów webhooków |
POST/v1/webhook_endpoints | Utwórz endpoint webhooka |
GET/v1/webhook_endpoints/{id} | Pobierz endpoint webhooka |
DELETE/v1/webhook_endpoints/{id} | Usuń endpoint webhooka |
| Zdarzenia | |
GET/v1/events | Lista zdarzeń |
GET/v1/events/{id} | Pobierz zdarzenie |
Adres i format
- Adres bazowy:
https://app.ksefshop.pl, wszystkie ścieżki z prefiksem/v1. - Treść żądań i odpowiedzi: JSON w UTF-8 (
Content-Type: application/json); wyjątek to PDF. - Uwierzytelnianie:
Authorization: Bearer sk_test_.... Klucze - Kwoty to teksty z kropką (
"49.00"), żeby uniknąć błędów zaokrągleń liczb zmiennoprzecinkowych. - Znaczniki czasu w odpowiedziach (
created,updated) to sekundy Unix; daty w żądaniach to ISO 8601.
Identyfikatory
| Prefiks | Obiekt |
|---|---|
inv_ |
Faktura |
cor_ |
Korekta |
we_ |
Endpoint webhooka |
evt_ |
Zdarzenie |
acct_ |
Konto |
req_ |
Żądanie (nagłówek Request-Id) |
Nagłówki odpowiedzi
| Nagłówek | Znaczenie |
|---|---|
Request-Id |
Id żądania, podawaj w zgłoszeniach. |
KSeF-Api-Version |
Wersja API (data). |
RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset |
Limit zapytań. |
Idempotent-Replayed |
true, gdy odpowiedź jest powtórką. Idempotencja |
Retry-After |
Przy 429: ile sekund czekać. |
Specyfikacja
Pełna specyfikacja OpenAPI 3.1: openapi.yaml. Kolekcja Postman z gotowymi scenariuszami: ksef-faktury.postman_collection.json.