Histórico da Página

http://fluig.totvs.com/api/v1/users

Duas versões da API podem ser suportadas e neste caso deve existir uma politica de depreciação e esta deve estar documentada em um local acessível ao usuário final.

Quando alterar a versão de uma API

O numero da versão indica para o cliente quando alguma alteração pode "quebrar" o código escrito por ele. Deve-se tomar um cuidado especial no processo de versionamento para que o cliente esteja ciente dessas alterações e a frequência com que essas quebras acontecem.

Alterações que devem gerar uma nova versão:

• URIs foram removidas ou renomeadas;
• Foram removidos campos do retorno de um endpoint;
• Foi removido o suporte a um método do endpoint (GET, PUT, POST, etc);
• Um novo parâmetro obrigatório é exigido para o correto funcionamento do endpoint;
• Um novo endpoint foi adicionado a API.

Alterações que NÃO devem gerar uma nova versão:

Um novo formato de retorno é suportado pelo endpoint;

• Novas propriedades são retornadas na entidade de retorno do endpoint;
• Novos parâmetros opcionais podem ser passados para o endpoint.