From 1bff907795ce7b8a28a56fc3afe0174c174f9d00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Richard=20Kub=C3=AD=C4=8Dek?= Date: Thu, 16 Jan 2025 13:39:13 +0100 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e3219c..4da9bd6 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -# SuperFaktura API client \ No newline at end of file +# SuperFaktura API client + +Library for handling of SuperFaktura API. + +Environment variables: +- `SUPERFAKTURA_API_KEY`: can be found in your SuperFaktura account (*Tools > API access*). +- `SUPERFAKTURA_API_URL`: url depends on the [Base URLs](README.md#base-urls) +- `SUPERFAKTURA_API_EMAIL`: can be found in your SuperFaktura account (*Tools > API access*). +- `SUPERFAKTURA_API_COMPANY_ID`: can be found in your SuperFaktura account (*Tools > API access*). + +## Base URLs + +Base URLs for different SuperFaktura versions. + +| Country | URL | +| -------------- | ------------------------------- | +| Slovakia | https://moja.superfaktura.sk | +| Czech republic | https://moje.superfaktura.cz | +| Austria | https://meine.superfaktura.at | +| Sandbox (SK) | https://sandbox.superfaktura.sk | +| Sandbox (CZ) | https://sandbox.superfaktura.cz |