Adresy
| Środowisko | Adres bazowy |
|---|---|
| Produkcja | https://api.infakt.pl/v3 |
| Sandbox (testy) | https://api.sandbox-infakt.pl/v3 |
Ścieżki /v3 i /api/v3 są równoważne. Każda ścieżka musi kończyć się sufiksem .json.
Zasady
| Zasada | Szczegóły |
|---|---|
Sufiks .json |
Każda ścieżka musi kończyć się sufiksem .json. Żądanie bez sufiksu otrzymuje odpowiedź 406 Not Acceptable. |
| Format treści | Treść żądań POST, PUT, PATCH i DELETE przesyła się jako JSON w kodowaniu UTF-8, z nagłówkiem Content-Type: application/json. |
| Uwierzytelnianie | Każde żądanie musi zawierać nagłówek X-inFakt-ApiKey (Uprawnienia). |
| Szyfrowanie | Wyłącznie HTTPS z TLS 1.2 lub TLS 1.3. |
PUT i PATCH |
Każda operacja PUT przyjmuje również metodę PATCH. |
| Wersja | Ta dokumentacja dotyczy API w wersji 3 (/v3). Niektóre operacje przyjmują nagłówek X-inFakt-ApiVersion: 3.1, który zmienia format odpowiedzi. Jego działanie opisuje referencja API przy tych operacjach. |
Buforowanie
Odpowiedzi na żądania GET zawierają nagłówek ETag. Jeśli przy kolejnym żądaniu przekażesz jego wartość w nagłówku If-None-Match, a dane się nie zmieniły, API może odpowiedzieć kodem 304 Not Modified bez treści.
curl -i "https://api.sandbox-infakt.pl/v3/clients.json" \
-H "X-inFakt-ApiKey: $INFAKT_API_KEY" \
-H 'If-None-Match: "<wartość-etag>"'