APIs JSON vs. XML

Escolher entre JSON e XML é uma questão do contrato entre o cliente e a API. Um cliente bem-feito diferencia sucesso, erros de validação, falhas de autenticação, limites de taxa e erros temporários do servidor. O formato, JSON ou XML, não altera a semântica do HTTP, e os valores IPv4/IPv6 devem ser preservados sem supor que todo endereço tem o tamanho de um IPv4.

O que validar na resposta

Confira o Content-Type, o código de status, os campos documentados e a cota. Dê tratamento próprio ao HTTP 429, respeite o Retry-After quando ele vier e use backoff exponencial limitado, com jitter. Antes de repetir uma requisição, avalie a idempotência. Nos logs, registre os identificadores das requisições, o status e a latência, nunca os segredos da API.

Como escolher o formato

O JSON se encaixa naturalmente em modelos de dados com objetos e arrays e costuma ser compacto; o XML tem atributos, namespaces e ferramentas de esquema bem maduras. Decida pelo contrato e pelo ecossistema da API, sem partir do princípio de que um formato é sempre mais rápido ou mais correto. Para testar uma requisição real e conhecer o contrato atual, veja a API da 2IP.