Histórico da Página

...

Uma API não deve ser confundida com um schema. As APIs são contratos responsáveis por definir os métodos e caminhos que permitem a comunicação entre dois pontos. São as APIs que definem trazem informações relevantes sobre as trocas de dados entre uma aplicação e um produto TOTVS, definindo os moldes das mensagens trafegadas. Já o schema é a mensagem padronizada propriamente dita. Traz consigo uma forma de apresentar dados e seus tipos, permitindo a posterior transmissão de informações. Definições mais apuradas sobre os schemas podem ser encontradas nesta na documentação sobre as mensagens padronizadas TOTVS.

Anteriormente era possível que o schema fosse incluso diretamente na API, porém essa regra foi modificada. Para aprimorar a reusabilidade dos schemas, agora os arquivos JSON devem ser separados em API e JsonSchema. Esse modelo possibilita a utilização do protocolo transactions sem que haja a necessidade do desenvolvimento de desenvolver uma API, caso essa configuração seja suficiente para suprir a necessidade e interesse do desenvolvedor.  

<Tópico pendente de informação>

Justificar quebra entre dois arquivos distintos. Reusabilidade. Pessoa pode usar o protocolo transactions e se comunicar utilizando apenas schema. Caso outra aplicação necessite, consegue se comunicar através das APIs, seguindo padrão OpenAPI.

API é o contrato, traz informações importantes que definem os moldes das mensagens trafegadas. API Reference mostra as APIs, não os schemas

Schema são as mensagens padronizadas propriamente ditas. Trazem as definições dos types, binda com os produtos totvs através do x-totvs.

  Como vantagem adicional, uma mesma API pode ser utilizada de formas diferentes, alterando somente o schema o qual ela faz referência.

Para uma melhor apresentação visual das APIs, foi desenvolvido o portal API Reference, onde todas as APIs desenvolvidas pelos segmentos TOTVS podem ser encontradas.Os arquivos que especificam 

O que é a propriedade "x-totvs"

...