Dokumentacja

Ładowanie kolejnej sekcji

Przygotowujemy widok dokumentacji bez pełnego przeładowania strony.

Ładowanie dokumentacji

Za chwilę pokażemy następną sekcję dokumentacji w tym samym układzie, bez wizualnego powrotu do starego interfejsu.

Warstwa API grupuje funkcje platformowe i integracyjne pod spójną konwencją wersjonowania v1.

https://api.wojticore.eu/api/v1

Nowe kontrakty powinny trafiać do jasno określonej wersji API, aby nie zrywać integracji działających klientów.

Każdy endpoint powinien jasno wskazywać, czy wymaga klucza tenantowego czy platformowego.

Błędy, walidacja i dane powinny być zwracane w przewidywalnym formacie, tak aby integracje mogły łatwo obsługiwać odpowiedzi.

{
  ok: boolean
  data?: unknown
  error?: {
    code: string
    message: string
  }
}

curl "https://api.wojticore.eu/api/v1/tenants/km-fix/clients" \
  -H "x-api-key: wk_live_xxx"

curl "https://api.wojticore.eu/api/v1/tenants/km-fix/repairs" \
  -H "Authorization: Bearer wk_live_xxx"

{
  "ok": false,
  "error": {
    "code": "tenant_key_tenant_mismatch",
    "message": "Klucz tenantowy nie pasuje do wskazanego tenanta."
  }
}

/api/v1 zwraca indeks API oraz odnośnik do dokumentacji.
/api/v1/docs jest publicznym katalogiem endpointów i opisem autoryzacji.
/api/v1/platform/* jest zarezerwowane dla kluczy platformowych.
/api/v1/tenants/{tenant}/* może być obsługiwane przez klucze platformowe lub tenantowe przypisane do konkretnego serwisu.

curl https://api.wojticore.eu/api/v1/tenants/km-fix/clients \
  -H "x-api-key: wk_live_..."

Klucz wygenerowany dla innego tenanta otrzyma odpowiedź 403 tenant_key_tenant_mismatch.