Melhores Práticas

Monitore a sua aplicação

Você monitora quantos status HTTP 4xx sua aplicação está recebendo? É comum a gente encontrar integrações que tentam atualizar um recurso, recebem um erro HTTP 4xx e continuam tentando atualizar esse recurso sem qualquer alteração na request, indefinidamente.

Nesse caso, o ideal é que ao receber um erro HTTP 4xx, a aplicação só tente repetir a requisição depois que a causa raiz do erro for solucionada. (Ex: a adição de um campo obrigatório que estava faltando na requisição)

Cuidado com o limite de requisições

Tenha cuidado para não ultrapassar os limites de requisições da nossa API. Caso a sua aplicação receba um HTTP 429, ela deve parar de fazer requisições por um tempo até que uma nova janela comece a contar.

Cuidado com datas com um alto volume de vendas, como a blackfriday. Acontece do desenvolvedor colocar mais máquinas para ter uma "integração mais rápida" e ser barrado no nosso limite de requisições.

Atualize apenas o necessário

Alguns recursos da API SkyHub, em especial a de produtos, permite que apenas alguns campos sejam passados na requisição de atualização. Se você deseja atualizar apenas o campo "qty" do produto, você deveria fazer semelhante à requisição abaixo:

curl --request PUT \
--url https://api.skyhub.com.br/products/sku123 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-User-Email: seu@email.com' \
--header 'X-Api-Key: YOUR-API-KEY-HERE' \
--header 'X-Accountmanager-Key: token_account'\
--data '{"qty":0}'

Desta forma sua aplicação terá que trafegar menos dados na rede, a API SkyHub terá que processar uma carga menor de dados e terá um desempenho melhor.