Antwortformat
Alle Wappfy-API-Antworten folgen einem einheitlichen Envelope-Format.
Erfolgreiche Antworten
Jede erfolgreiche Antwort wird in ein Standard-Objekt verpackt:
{
"success": true,
"data": { ... },
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-02-10T12:00:00.000Z"
}
}
| Feld | Typ | Beschreibung |
|---|
success | boolean | Immer true bei erfolgreichen Antworten |
data | object | array | Die Antwort-Nutzlast |
meta.requestId | string | Eindeutige Anfrage-ID zur Fehlersuche |
meta.timestamp | string | ISO-8601-Zeitstempel |
Paginierte Antworten
Endpunkte, die Listen zurueckgeben, enthalten Paginierungs-Metadaten:
{
"success": true,
"data": {
"items": [ ... ],
"total": 42,
"page": 1,
"limit": 20,
"totalPages": 3
},
"meta": {
"requestId": "req_def456",
"timestamp": "2026-02-10T12:00:00.000Z"
}
}
page und limit, um die Paginierung zu steuern:
GET /api/instances?page=2&limit=10
Fehlerantworten
Fehlgeschlagene Anfragen liefern ein Fehler-Objekt zurueck:
{
"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"
}
}
Haeufige Fehlercodes
| HTTP-Status | Code | Beschreibung |
|---|
400 | VALIDATION_ERROR | Validierung des Anfrageinhalts fehlgeschlagen |
401 | UNAUTHORIZED | Fehlender oder ungueltiger Auth-Token |
403 | FORBIDDEN | Unzureichende Berechtigungen |
404 | NOT_FOUND | Ressource existiert nicht |
409 | PLAN_LIMIT_REACHED | Instanz-Limit Ihres Tarifs erreicht |
429 | RATE_LIMIT_EXCEEDED | Zu viele Anfragen |
500 | INTERNAL_ERROR | Unerwarteter Serverfehler |
Die meta.requestId ist nuetzlich fuer Support-Anfragen — geben Sie sie an, wenn Sie den Support kontaktieren, um die Fehlersuche zu beschleunigen.
