Przegląd API
HUBanero udostępnia dwa rodzaje API: OData i REST.
Architektura API
OData vs REST
| Aspekt | OData | REST |
|---|---|---|
| Użycie | CRUD encji | Operacje biznesowe |
| Format | Standardowy OData | Custom JSON |
| Filtrowanie | $filter, $orderby | Query params |
| Przykład | GET /odata/Clients | POST /api/invoices/send |
Autentykacja
Wszystkie endpointy wymagają autentykacji JWT:
curl -H "Authorization: Bearer {token}" \
https://api.hubanero.pl/odata/Clients
Token uzyskujesz przez endpoint logowania:
POST /api/auth/login
{
"username": "user@example.com",
"password": "secret"
}
Swagger
Pełna dokumentacja API dostępna pod:
- http://localhost:5000/swagger (lokalnie)
Rate limiting
- 100 req/min dla standardowych użytkowników
- 1000 req/min dla API keys
Wersjonowanie
API jest wersjonowane przez prefix URL:
/api/v1/...(aktualna wersja)
Starsze wersje są wspierane przez min. 12 miesięcy.