Dokumentacja w fazie alpha
Nawigacja

Endpointy API

Lista dostępnych endpointów i przykładowe zapytania.

Ostatnia aktualizacja: 2026-04-01

Bazowy URL

Wszystkie endpointy API są dostępne pod adresem: https://app.bakepilot.pl/api/v1/. Odpowiedzi są w formacie JSON. Kodowanie: UTF-8. Wszystkie daty w formacie ISO 8601.

  • Bazowy URL: https://app.bakepilot.pl/api/v1/
  • Format odpowiedzi: JSON
  • Kodowanie: UTF-8
  • Daty: ISO 8601 (np. 2026-04-07T10:30:00Z)

Zamówienia

Endpointy zamówień pozwalają pobierać listę zamówień, szczegóły, tworzyć nowe i aktualizować istniejące. GET /orders - lista zamówień z paginacją. GET /orders/:id - szczegóły zamówienia. POST /orders - nowe zamówienie. PATCH /orders/:id - aktualizacja.

  • GET /orders - lista zamówień (paginacja, filtrowanie)
  • GET /orders/:id - szczegóły zamówienia
  • POST /orders - utworzenie zamówienia
  • PATCH /orders/:id - aktualizacja (np. zmiana statusu)
  • DELETE /orders/:id - anulowanie zamówienia

Klienci

Endpointy klientów: pobieranie listy, szczegółów, tworzenie i aktualizacja. GET /customers - lista z wyszukiwaniem. POST /customers - nowy klient. PATCH /customers/:id - aktualizacja danych.

  • GET /customers - lista klientów
  • GET /customers/:id - profil klienta z historią
  • POST /customers - dodanie klienta
  • PATCH /customers/:id - aktualizacja danych

Produkty i faktury

Analogiczne endpointy dla produktów (/products) i faktur (/invoices). Produkty: lista, szczegóły, CRUD. Faktury: lista, szczegóły, tworzenie, wysyłka do KSeF.

  • GET/POST/PATCH /products - zarządzanie produktami
  • GET/POST /invoices - zarządzanie fakturami
  • POST /invoices/:id/send-ksef - wysyłka do KSeF
  • GET /invoices/:id/pdf - pobranie PDF

Obsługa błędów

API zwraca standardowe kody HTTP: 200 (sukces), 201 (utworzono), 400 (błędne dane), 401 (brak autoryzacji), 403 (brak uprawnień), 404 (nie znaleziono), 429 (limit zapytań). Każdy błąd zawiera pole 'error' z opisem po angielsku.

  • 200 OK - zapytanie udane
  • 201 Created - zasob utworzony
  • 400 Bad Request - błędne dane wejściowe
  • 401 Unauthorized - brak lub błędny klucz API
  • 404 Not Found - zasob nie istnieje
  • 429 Too Many Requests - przekroczono limit