Histórico da Página

...

• Entidade apresentada no plural e uso correto do parâmetro na url.
  • https://totvs.com/api/fluig/fdn/v1/users/{id}

• Ações sobre entidades no caminho da url e como parâmetro da url.
  • https://totvs.com/api/fluig/bpm/v1/workflows/{id}?action=execute
  • https://totvs.com/api/fluig/bpm/v1/workflows/{id}/send

• Relacionando entidades diretamente no caminho
  
  • https://totvs.com/api/fluig/fdn/v1/users/{alias}/communities
  • https://totvs.com/api/fluig/social/v1/communities/{id}/users

• URL com suporte a campos expansíveis
  
  • https://totvs.com/api/fluig/fdn/v1/users/{alias}?expand=prop1.subprop,prop2

• Ordenando e paginando coleções
  • https://totvs.com/api/fluig/fdn/v1/users?order=name,-age&page=2&pageSize=20
• URL com Query Param e nome composto:
  • https://totvs.com/api/fluig/fdn/v1/users/?firstName=joao

...

Consideramos uma API o agrupamento de endpoints que façam parte da mesma unidade de negócio, criar um novo grupo de endpoints implica em preocupações como versionamento, disponibilidade e documentação. Usamos como base a estrutura "{protocolo}://{host}/{api}/{produto}/{agrupador}/{dominio}/{versao}/{recurso}". Ex: https://fluig.totvs.com/api/fluigecm/ecmsucurity/v1/users. A partir deste ponto deve-se considerar como regra básica a complexidade necessária para descobrir estes endpoints, ou seja, o agrupamento deve facilitar e não complicar a descoberta dos serviços.

...

...