Endpointy API

Doxtly udostępnia REST API zbudowane z API Platform. Wszystkie endpointy zwracają odpowiedzi JSON i stosują standardowe konwencje HTTP.

Bazowy URL

https://api.{twoja-subdomena}.doxtly.com/api

Dokumenty

Szablony

Metoda	Endpoint	Opis
GET	/document-templates	Lista wszystkich szablonów dokumentów
POST	/document-templates	Utwórz nowy szablon
GET	/document-templates/{id}	Szczegóły szablonu
PUT	/document-templates/{id}	Zaktualizuj szablon
DELETE	/document-templates/{id}	Usuń szablon

Generowanie dokumentów

Metoda	Endpoint	Opis
POST	/document-templates/{id}/generate	Wygeneruj PDF z szablonu
GET	/generated-documents	Lista wygenerowanych dokumentów
GET	/generated-documents/{id}	Szczegóły dokumentu
GET	/generated-documents/{id}/download	Pobierz plik PDF
DELETE	/generated-documents/{id}	Usuń wygenerowany dokument

Generowanie dokumentu

curl -X POST https://api.twojafirma.doxtly.com/api/document-templates/{id}/generate \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "variables": {
      "nazwa_klienta": "Firma ABC",
      "kwota": 1500
    }
  }'

Formularze

Metoda	Endpoint	Opis
GET	/form-definitions	Lista wszystkich formularzy
POST	/form-definitions	Utwórz nowy formularz
GET	/form-definitions/{id}	Szczegóły formularza
PUT	/form-definitions/{id}	Zaktualizuj formularz
DELETE	/form-definitions/{id}	Usuń formularz
GET	/form-definitions/{id}/submissions	Lista zgłoszeń formularza
POST	/public/forms/{slug}	Wyślij publiczny formularz

Workflow

Metoda	Endpoint	Opis
GET	/workflows	Lista wszystkich workflow
POST	/workflows	Utwórz nowy workflow
GET	/workflows/{id}	Szczegóły workflow
PUT	/workflows/{id}	Zaktualizuj workflow
DELETE	/workflows/{id}	Usuń workflow
POST	/workflows/{id}/execute	Ręcznie uruchom workflow
GET	/workflow-executions	Lista wykonań workflow
GET	/workflow-executions/{id}	Szczegóły wykonania
POST	/workflow-executions/{id}/rerun	Ponownie uruchom nieudane wykonanie

Szablony e-mail

Metoda	Endpoint	Opis
GET	/email-templates	Lista wszystkich szablonów e-mail
POST	/email-templates	Utwórz nowy szablon
GET	/email-templates/{id}	Szczegóły szablonu
PUT	/email-templates/{id}	Zaktualizuj szablon
DELETE	/email-templates/{id}	Usuń szablon
POST	/email-templates/{id}/send	Wyślij e-mail za pomocą szablonu

Subskrypcja i użycie

Metoda	Endpoint	Opis
GET	/subscription	Szczegóły bieżącej subskrypcji
GET	/subscription/usage	Bieżące statystyki użycia

Paginacja

Endpointy listowe obsługują paginację za pomocą parametrów zapytania:

GET /api/documents?page=1&itemsPerPage=25

Odpowiedź zawiera metadane paginacji:

{
  "hydra:member": [...],
  "hydra:totalItems": 42,
  "hydra:view": {
    "hydra:first": "/api/documents?page=1",
    "hydra:last": "/api/documents?page=2",
    "hydra:next": "/api/documents?page=2"
  }
}

Odpowiedzi błędów

Błędy stosują standardowy format API Platform:

{
  "hydra:title": "Wystąpił błąd",
  "hydra:description": "Szablon dokumentu nie został znaleziony.",
  "status": 404
}

Typowe kody statusu HTTP:

Kod	Znaczenie
200	Sukces
201	Utworzono
204	Brak treści (pomyślne usunięcie)
400	Błędne żądanie (błąd walidacji)
401	Nieautoryzowany
403	Zabroniony
404	Nie znaleziono
422	Nieprzetwarzalna encja
429	Przekroczono limit żądań