success alanı üzerinden işaretler.
Başarı yanıtı
data bir dizi, links ve meta da bulunur — bkz. Sayfalama.
Hata yanıtı
Hata yanıtlarında her zaman
false.Kısa, insan-okunur hata mesajı. UI’da göstermek için uygundur.
Yalnızca 422 doğrulama hatalarında bulunur. Alan adından hata mesajları dizisine doğru bir map’tir.
HTTP status kodları
| Kod | Anlamı | Ne yapmalı? |
|---|---|---|
200 OK | Başarılı okuma | — |
201 Created | Kaynak oluşturuldu | Dönen data’daki ID’yi saklayın |
204 No Content | Başarılı silme | Yanıt gövdesi yoktur |
400 Bad Request | Geçersiz JSON, eksik X-Tenant | İstek gövdesini ve header’larını kontrol edin |
401 Unauthorized | Token yok, geçersiz veya süresi dolmuş | Token yenilemeyi deneyin; başarısızsa yeniden yetkilendirin |
403 Forbidden | Token’ın scope’u yetersiz veya kullanıcının permission’ı yok | Scopes ve Roller sayfalarına bakın |
404 Not Found | Kaynak yok veya kullanıcının o tenant’a/kayda erişimi yok | ID ve tenant’ı doğrulayın |
409 Conflict | Çakışan değişiklik (nadiren) | Mevcut kaydı tekrar çekip işlem yapın |
422 Unprocessable Entity | Doğrulama hatası | errors nesnesini okuyup alan alan gösterin |
429 Too Many Requests | Rate limit aşıldı | Retry-After header’ına göre bekleyin |
500 Internal Server Error | Sunucu tarafı beklenmeyen hata | Biraz bekleyip tekrar deneyin; sürerse destek |
503 Service Unavailable | Bakım / geçici kesinti | Retry-After header’ı varsa ona uyun |
Yaygın hata senaryoları
Token süresi doldu
X-Tenant unutuldu
X-Tenant header’ını ekleyin. Detay: Multi-Tenancy.
Scope yetersiz
POST /customers için customers:write scope’u gerekir. Token’ınızın scope listesini Scopes ile karşılaştırın; gerekli scope’u uygulama oluştururken eklemediyseniz yeni bir uygulama oluşturmanız gerekir.