Páginas filhas
  • Guia de implementacao das APIs TOTVS

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Ajuste no formato de data e hora sugerido, para um sem milissegundos.

...

  • Definir práticas e padrões consistentes para todos os endpoints das APIs da TOTVS;
  • Garantir a utilização mais próxima possível das boas práticas estipuladas pelos padrões REST/HTTP;
  • Tornar os serviços da TOTVS acessíveis através de APIs facilmente compreendidas e documentadas para desenvolvedores e consumidores.

Nota
titleImportante!

prop1.prop2.prop3.Atente-se para esta documentação. Para garantir um bom desenvolvimento de APIs publicas ou privadas, é imprescindível que os passos a seguir sejam respeitados.

...

  • Data UTC estendido (E8601DZw.d): yyyy-mm-ddThh:mm:ss.nnnnnn+|-hh:mm
  • Data (E8601DAw.): yyyy-mm-dd
  • Hora (E8601TMw.d): hh:mm:ss.ffffff

...

Informações

Detalhes sobre o padrão UTC podem ser encontrados nos documentosISO-8601 e uma tabela com os formatos E8601DZw.d, E8601DAw. e E8601TMw.d podem ser encontrados no documento Extended Notations.

Coleções

Ordenação

Todos os endpoints de coleção devem suportar ordenação. A definição de como a lista deve ser ordenada é definida no parâmetro de url order respeitando as seguintes regras:

...

Informações
titleVerbos HTTP x parâmetros expansíveis
A técnica de parâmetros expansíveis se aplica a todos os verbos HTTP onde o corpo contenha estruturas passíveis de retração (listas ou objetos). Por exemplo, se num endpoint usando POST o retorno contenha, no corpo, um objeto contendo uma lista, esta deve vir retraída e o atributo deve constar no parâmetro _expandables.

...