Histórico da Página
...
No caso de JSON simplificado para API, trabalhamos apenas com o contéudo conteúdo da propriedade "content", desconsiderando o header.
Veja abaixo o exemplo do mesmo JSON definido acima, porém simplificado como modelo de request/response de uma API.
...
Clique aqui para obter mais informações sobre integração via API
Definição da Mensagem Padronizada no modelo JsonSchema
Abaixo encontram-se as regras para definir uma mensagem padronizada.
- Seguir a especificação do formato: https://json-schema.org/specification.html
- X-Totvs
- Types comuns
- Sempre que possível, utilizar padrões internacionais. Para saber se já existe uma mensagem de conta contábil, por exemplo, pesquise no Google usando "account xsd oasis repository".
- Mensagens criadas para atender uma exigência legal devem se ater estritamente ao que é definido pela legislação. Nestes casos, o nome da mensagem e dos campos podem ser em português, se a legislação exigir.
Exemplos JsonSchema:
Json Schema da Mensagem Branch 2.001 : https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_001.json
Outros Json Schemas aprovados: https://github.com/totvs/ttalk-standard-message/tree/master/jsonschema/schemas
Exemplos Oficiais site json-schema: https://json-schema.org/learn/miscellaneous-examples.html
Padrões internacionais de mensagens para integração
http://docs.oasis-open.org/ubl/prd1-UBL-2.1/UBL-2.1.html
http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v1.0/cnd02/UBL-2.1-JSON-v1.0-cnd02.html
http://docs.oasis-open.org/ubl/UBL-2.1-JSON/v1.0/cnd02/json-schema/maindoc/
http://www.unece.org/cefact/brs/brs_index.html