Przejdź do głównej zawartości

Przegląd API

HUBanero udostępnia dwa rodzaje API: OData i REST.

Architektura API

OData vs REST

AspektODataREST
UżycieCRUD encjiOperacje biznesowe
FormatStandardowy ODataCustom JSON
Filtrowanie$filter, $orderbyQuery params
PrzykładGET /odata/ClientsPOST /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:

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.