API Finance.HDdev
Zintegruj Finance.HDdev ze swoimi narzędziami. Uzyskaj dostęp do kont, transakcji, budżetów i kategorii przez proste i bezpieczne API REST.
Uwierzytelnianie
Bearer token (JWT). Uzyskaj token z panelu osobistego w ustawieniach konta.
Base URL
Wszystkie żądania używają następującego Base URL:
https://finance.hddev.eu/api/v1Format
Wszystkie żądania i odpowiedzi używają formatu JSON. Wymagany nagłówek: Content-Type: application/json
Przykład uwierzytelniania
curl -X GET https://finance.hddev.eu/api/v1/accounts \ -H "Authorization: Bearer VOTRE_TOKEN_JWT" \ -H "Content-Type: application/json"
Dostępne endpointy
Przegląd głównych endpointów API Finance.HDdev.
/api/v1/accountsLista połączonych kont bankowych z saldami i metadanymi.
/api/v1/transactionsLista transakcji z filtrami (data, kategoria, kwota, konto).
/api/v1/budgetsBudżety i cele z aktualnym postępem.
/api/v1/transactionsTworzenie ręcznej transakcji (wydatek, przychód lub przelew).
/api/v1/categoriesDostępne kategorie (systemowe i własne).
Limity żądań
Żądania API są limitowane w celu zapewnienia stabilności usługi.
Pełna dokumentacja
Pełna interaktywna dokumentacja (OpenAPI / Swagger) będzie wkrótce dostępna. Będzie zawierać schematy żądań i odpowiedzi, kody błędów i szczegółowe przykłady.
Bezpieczeństwo
Cała komunikacja jest szyfrowana przez HTTPS/TLS. Tokeny JWT wygasają po 30 minutach (automatyczne odnawianie przez refresh token). API jest zgodne z RODO i nigdy nie zwraca danych logowania do banku.
Potrzebujesz pomocy z API?
Nasz zespół techniczny jest dostępny, aby pomóc Ci zintegrować API Finance.HDdev z Twoimi narzędziami i przepływami pracy.
Skontaktuj się z zespołem APIapi@hddev.eu
Zasady architektury i użytkowania
API Finance.HDdev opiera się na architekturze RESTful, co czyni je przewidywalnym i łatwym w użyciu. Wszystkie żądania są wykonywane przez HTTPS w celu zagwarantowania poufności wymienianych danych. Odpowiedzi, a także treści żądań POST i PUT, są systematycznie formatowane w JSON. Struktura adresów URL jest zorientowana na zasoby, pozwalając Ci w intuicyjny sposób wchodzić w interakcje z różnymi obiektami naszego systemu, takimi jak konta, transakcje czy budżety. Stosujemy system limitowania żądań (rate limiting) w celu zapewnienia stabilności platformy dla wszystkich użytkowników. Szczegóły tych limitów są podane w nagłówku każdej odpowiedzi.
Kluczowe endpointy i przypadki użycia
Nasze API udostępnia kilka endpointów obejmujących cały zakres funkcji zarządzania finansami. Endpoint `/transactions` pozwala na listowanie, filtrowanie i pobieranie szczegółów każdej transakcji, co jest idealne do zaawansowanych analiz wydatków. Dzięki `/accounts` możesz uzyskać listę połączonych kont i ich salda w czasie rzeczywistym. Do śledzenia budżetowego endpointy `/budgets` i `/categories` dają Ci pełną kontrolę nad tworzeniem i śledzeniem kopert wydatkowych. Endpoint `/goals` pozwala zarządzać celami oszczędnościowymi. Te narzędzia w połączeniu otwierają drogę do wielu zastosowań, od prostego skryptu eksportu danych po kompletną aplikację mobilną coachingu finansowego.
Uwierzytelnianie i bezpieczeństwo API
Bezpieczeństwo jest naszym absolutnym priorytetem. Dostęp do API jest chroniony osobistymi kluczami uwierzytelniania, które możesz generować, zarządzać i unieważniać z dashboardu użytkownika. Każde żądanie API musi zawierać klucz API w nagłówku `Authorization` w formie Bearer Token. Niezbędne jest zachowanie tych kluczy w tajemnicy i nigdy nie eksponowanie ich po stronie klienta (np. w kodzie JavaScript przeglądarki). Wszystkie połączenia z API są szyfrowane TLS (SSL). Zachęcamy również do korzystania z webhooków do otrzymywania powiadomień w czasie rzeczywistym o ważnych zdarzeniach, takich jak nowa transakcja, zamiast ciągłego odpytywania API, co zmniejsza liczbę żądań i optymalizuje wydajność.