Glossário

Adapter

Camada de software que implementa a comunicação entre a API e a camada de negócio do produto.

API

Camada de software responsável por implementar os endpoints, que se comunicam com o adapter do produto. Desta forma, apenas com as informações referentes aos endpoints, é possível interagir com o sistema.

Comitê

Grupo responsável pela análise e aprovação de novas APIs e mensagens, formado por integrantes da equipe TTalk (comitê técnico) e de membros de áreas de negócio abrangendo os produtos da TOTVS. O contato pode ser feito através do e-mail [email protected].

Endpoint

Um endpoint de uma API é a URL onde seu serviço pode ser acessado por uma aplicação cliente. Na especificação OpenAPI utilizada pela TOTVS, os endpoints estão localizados na propriedade "paths".

InternalId

Mecanismo de equivalência de chaves, necessário para o funcionamento da tabela de/para. Informações mais detalhadas sobre o assunto podem ser encontradas nesta página.

JsonSchema

É o padrão que modela a mensagem padronizada propriamente dita (utilizando JSON). 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 na documentação sobre as mensagens padronizadas TOTVS.

Mensagem

Conteúdos/dados trafegados entre dois pontos, seja por protocolo transactions ou por APIs.

OpenAPI

Padrão internacional para especificação de APIs utilizado pelas integrações TOTVS. Maiores informações podem ser encontradas neste tópico.

Transactions (protocolo)

Forma padrão de utilização da mensagem padronizada TOTVS quando a integração trata de produtos TOTVS nas duas pontas da transmissão de mensagens. Maiores informações podem ser encontradas neste tópico.

Type

É a definição de um tipo de dado em um schema, especificado dentro do elemento "definitions" do jsonschema.

X-Totvs

A propriedade x-totvs tem como objetivo armazenar dados pertinentes aos produtos TOTVS. Dependendo do trecho do arquivo JSON que ela está inserida, possui diferentes elementos. Maiores informações sobre o x-totvs dos OpenAPIs podem ser encontrados aqui, enquanto x-totvs dos schemas podem ser encontrados aqui.