JSON ve XML API'leri

JSON ile XML arasındaki seçim, istemci ile API arasındaki sözleşmenin bir parçasıdır. İstemci başarılı yanıtı, doğrulama hatalarını, kimlik doğrulama hatalarını, hız sınırını ve geçici sunucu hatalarını birbirinden ayırabilmelidir. JSON ya da XML kullanmak HTTP semantiğini değiştirmez; IPv4/IPv6 değerleri de IPv4 uzunluğu varsayılmadan eksiksiz korunmalıdır.

API yanıtı nasıl işlenir?

Content-Type'ı, durum kodunu, belgelenmiş alanları ve kotayı kontrol edin. HTTP 429'u ayrı ele alın: Retry-After gönderilmişse ona uyun, jitter eklenmiş ve üst sınırı olan üstel geri çekilme (exponential backoff) kullanın. Yeniden denemeden önce işlemin idempotent olup olmadığını değerlendirin. İstek kimliklerini, durum kodunu ve gecikmeyi loglayın; API anahtarlarını ise asla loglara yazmayın.

Hangi format, ne zaman?

JSON, yaygın nesne/dizi veri modellerine doğrudan karşılık gelir ve genellikle daha kısadır; XML ise öznitelikleri, ad alanlarını (namespace) ve olgunlaşmış şema araçlarını destekler. Formatlardan birinin her zaman daha hızlı ya da daha doğru olduğunu varsaymayın; seçimi API sözleşmesine ve kullandığınız ekosisteme göre yapın. Gerçek bir istek denemek ve güncel API sözleşmesini görmek için 2IP API'si sayfasına bakın.