Przejdź do głównej treści

Format odpowiedzi

Wszystkie odpowiedzi Wappfy API stosuja spojny format koperty.

Odpowiedzi pomyslne

Kazda pomyslna odpowiedz jest opakowana w standardowy obiekt:
{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
PoleTypOpis
successbooleanZawsze true dla pomyslnych odpowiedzi
dataobject | arrayDane odpowiedzi
meta.requestIdstringUnikalny identyfikator zapytania do debugowania
meta.timestampstringZnacznik czasu w formacie ISO 8601

Odpowiedzi z paginacja

Endpointy zwracajace listy zawieraja metadane paginacji:
{
  "success": true,
  "data": {
    "items": [ ... ],
    "total": 42,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  },
  "meta": {
    "requestId": "req_def456",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
Uzyj parametrow zapytania page i limit do kontrolowania paginacji:
GET /api/instances?page=2&limit=10

Odpowiedzi bledow

Nieudane zapytania zwracaja obiekt bledu:
{
  "success": false,
  "error": {
    "code": "INSTANCE_NOT_FOUND",
    "message": "Instance with ID abc123 not found",
    "details": {}
  },
  "meta": {
    "requestId": "req_ghi789",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}

Typowe kody bledow

Status HTTPKodOpis
400VALIDATION_ERRORTresc zapytania nie przeszla walidacji
401UNAUTHORIZEDBrakujacy lub nieprawidlowy token uwierzytelniania
403FORBIDDENNiewystarczajace uprawnienia
404NOT_FOUNDZasob nie istnieje
409PLAN_LIMIT_REACHEDLimit instancji dla Twojego planu
429RATE_LIMIT_EXCEEDEDZbyt wiele zapytan
500INTERNAL_ERRORNieoczekiwany blad serwera
Pole meta.requestId jest przydatne przy zgloszeniach do wsparcia — dolacz je przy kontakcie z obsluga techniczna, aby przyspieszyc debugowanie.