Histórico da Página

...

Para descrever uma API, se faz necessária uma especificação padronizada. O padrão utilizado para a construção das APIs TOTVS é o OpenAPI 3.0, o qual descreve um formato para definição de toda a API. Essa especificação é que define como serão evidenciados os endpoints e seus métodos, parâmetros de operações de entrada e saída, métodos de autenticação, metadados (tais como informações gerais, contato, licença e termos de uso), entre outros.

Criação de uma API

<Tópico pendente de informação>

 As regras para o desenvolvimento de APIs estão especificadas no nosso Guia de Implementação de APIs.

...

Uma API não deve ser confundida com um schema. As APIs são interfaces que definem contratos responsáveis por definir os métodos e caminhos que permitem a comunicação entre dois pontos. São as APIs que definem os moldes das mensagens trafegadas. Já o schema é 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 documentação.

Anteriormente era possível que o schema fosse incluído 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 SchemaJsonSchema. Esse modelo possibilita a utilização do protocolo transactions sem a necessidade de desenvolver uma API, caso essa configuração seja suficiente para suprir a necessidade e interesse do desenvolvedor. Se uma   

<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.

...

Os arquivos que especificam 

O que é a propriedade "x-totvs"

<Tópico pendente de informação>

O objetivo do x-totvs é evidenciar informações pertinenetes aos produtos TOTVS.

Vincula o arquivo OpenAPI aos produtos TOTVS. Informações necessárias. Mostrar os campos, preenchimento de cada um, etc.

Implementação de APIs com Mensagem Padronizada

Identificar se o produto a ser integrado já está definido na documentação da API

<Tópico pendente de informação>

O API reference tira os dados do json da api. Ir no api reference e identificar se o produto ta la, dentro dos x-totvs

O que é a propriedade "x-totvs"

Vincula o arquivo OpenAPI aos produtos TOTVS. Informações necessárias. Mostrar os campos, preenchimento de cada um, etc.

Implementação de APIs com Mensagem Padronizada

Editar "x-totvs" da API

<Tópico pendente de informação>

Caso a api já exista mas não para seu produto, significa que você precisa aadaptar a API ao seu produto.

...