Versionamento da API

A API de Integrações usa versionamento via header customizado, garantindo que integrações existentes continuem funcionando quando novas versões forem lançadas.

Como usar

Envie o header api-version em suas requisições:

curl -H "Authorization: Bearer <token>" \
  -H "api-version: v1" \
  https://api.biterp.ai/products

Comportamento

Versões disponíveis

Boas práticas

1. Sempre envie o header: mesmo que a versão padrão funcione hoje, enviar explicitamente protege sua integração contra mudanças futuras
2. Teste antes de migrar: quando uma nova versão for lançada, teste sua integração antes de atualizar o header
3. Monitore deprecações: versões antigas serão depreciadas com antecedência

Exemplo de erro

Quando uma versão inválida é enviada, a resposta é 400 Bad Request com as versões aceitas:

{
    "statusCode": 400,
    "message": "Invalid api-version. Accepted: v1, v2. Current: v1",
    "error": "Bad Request"
}