Kontrola wydatków API

Kontrola wydatków API, Księga Przychodów i Wydatków zarządza rekordami z Twojej aplikacji: wyświetla listę, dodaje, aktualizuje i usuwa. Punkty końcowe korzystają z klucza API zamiast sesji przeglądarki.

Szybki start

Utwórz klucz w sekcji Developer API (https://pixepi.com/pl/konto) na swoim koncie; klucz w postaci zwykłego tekstu jest widoczny tylko w momencie jego utworzenia.
Wyślij zapytanie do https://api.pixepi.com z nagłówkiem Authorization: Bearer .
Odpowiedzi zwracają JSON; w endpointach list możesz używać pól page, per_page oraz filtrów.

Przykładowe żądanie

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories"

curl -X POST "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -d "kind=expense" \
  -d "name=Czynsz"

Endpointy tego narzędzia

Metoda	Ścieżka	Działanie
`GET`	`/categories`	Wyświetla kategorie (wspólne kategorie systemowe oraz Twoje własne).
`POST`	`/categories`	Dodaje nową kategorię.
`POST`	`/categories/{id}`	Aktualizuje kategorię.
`POST`	`/categories/{id}/archive`	Archiwizuje kategorię; ponowne wywołanie nie zmienia statusu.
`GET`	`/entries`	Wyświetla wpisy; filtruje według daty, typu, kategorii i notatki.
`POST`	`/entries`	Dodaje nowy wpis.
`POST`	`/entries/{id}`	Aktualizuje wpis.
`POST`	`/entries/{id}/delete`	Usuwa wpis.
`GET`	`/summary`	Podział podsumowania: według miesiąca, kategorii lub typu.
`GET`	`/export.csv`	Eksportuje wpisy jako CSV.

Wspólne endpointy

Metoda	Ścieżka	Działanie
`GET`	`/api/v1/apps`	Katalog API
`GET`	`/api/v1/apps/gelir-gider-defteri`	Kontrakt narzędzia
`GET`	`/api/v1/usage`	Podsumowanie użycia
`GET`	`/api/v1/openapi.json`	Dokument OpenAPI 3.1

Limity

Pole limit w odpowiedziach list zawiera informacje o zużyciu i limitach.
Informacje o limitach i planie są powiązane z twoim kontem; sprawdź bieżący stan za pomocą GET /api/v1/usage.

Kody błędów

Kod	Znaczenie
`unauthorized`	Brak klucza API lub klucz jest nieprawidłowy.
`forbidden`	Ta operacja jest niedozwolona dla tego klucza.
`not_found`	Nie znaleziono narzędzia, zadania ani rekordu (404 również dla dostępu międzykontowego).
`invalid_input`	Błąd walidacji danych (brakujące lub nieprawidłowe pole, błędna data itp.).
`invalid_request`	Nieprawidłowe żądanie.
`too_large`	Rozmiar pliku lub treści przekracza limit.
`unsupported_media`	Nieobsługiwany typ pliku.
`not_supported`	To narzędzie nie działa na tym punkcie końcowym (aplikacja stanowa).
`not_ready`	Zadanie nie jest jeszcze zakończone.
`expired`	Plik wyjściowy wygasł.
`no_output`	Brak wyniku do pobrania dla tego zadania.
`invalid_path`	Nieprawidłowa ścieżka wyjściowa.
`quota_exceeded`	Przekroczono limit lub przydział.
`rate_limited`	Zbyt wiele żądań w krótkim czasie; poczekaj chwilę i spróbuj ponownie.
`csrf`	Weryfikacja formularza przeglądarki nie powiodła się (zewnętrzne API używa kluczy).
`conflict`	Operacja koliduje z obecnym stanem.
`unavailable`	Narzędzie jest tymczasowo niedostępne.
`internal_error`	Nieoczekiwany błąd serwera.

Dokumenty

Często zadawane pytania

Gdzie mogę uzyskać klucz API?

Utwórz klucz w sekcji API dla programistów na swoim koncie; klucz jest widoczny tylko raz, w momencie jego wygenerowania.

Jak wysłać zapytanie?

Punkty końcowe działają pod adresem https://api.pixepi.com; każde zapytanie wymaga nagłówka "Authorization: Bearer <klucz>".

Jakie punkty końcowe udostępnia API Księga Przychodów i Wydatków?

Powyższa tabela zawiera listę dostępnych punktów końcowych; wszystkie operują na rekordach przypisanych do Twojego konta i zwracają kod 404 przy próbie dostępu z innego konta.

Jak interpretować odpowiedź z błędem?

Ciało błędu zawiera pola {ok:false, error, code, request_id}; wartości kodu znajdziesz w tabeli kodów błędów.