Descreva a troca
Para cada operação, documente o método, recurso, campos obrigatórios e o formato de uma resposta bem-sucedida. Inclua um erro de validação. Distinga uma falha de transporte de uma requisição rejeitada: uma resposta ausente não prova que uma operação que altera estado falhou.
Trate credenciais como configuração
Mantenha credenciais de servidor fora de pacotes de navegador e repositórios de código-fonte. Solicite o menor conjunto de permissões útil e separe o acesso de desenvolvimento do acesso de produção. Registre quem é o responsável por cada integração e como o acesso pode ser revogado. Siga o fluxo de autorização documentado pelo provedor.
Planeje para dependências indisponíveis
Defina tempos limite, respeite as orientações de limitação de taxa e tente novamente apenas quando uma operação for segura para repetir. Quando suportado, uma chave de idempotência pode identificar solicitações repetidas. Registre um identificador de solicitação e uma categoria de falha concisa; evite cabeçalhos de autorização, cookies de sessão e dados pessoais.