Objetivo e formas de uso
O objetivo da Mensagem Padronizada TOTVS (TOTVS Standard Message - TSM) é estabelecer padrões que devem ser seguidos por todos os aplicativos que participam da integração. Estes padrões definem os tipos de mensagens suportadas bem como informações obrigatórias que devem fazer parte do seu conteúdo.
A anatomia básica de uma mensagem permite que se defina apenas o modelo do conteúdo de negócio. Entretanto, quando for necessário um maior controle das mensagens trafegadas entre os produtos, é possível acrescentar modelos adicionais (como o modelo de dado para retorno de status de processamento), de forma todas as informações necessárias façam parte de uma única estrutura de mensagem.
A composição do conteúdo da mensagem no que diz respeito ao negócio será definida em conjunto com especialistas de negócio e não faz parte do escopo deste documento.
As orientações descritas neste documento, portanto, visam atender os dois modelos de integração existentes: API e Transactions.
Veja abaixo um exemplo de mensagem padronizada completa, em formato JSON, (incluindo header para controle da camada de EAI), trafegada no modelo Transactions:
Clique aqui para obter mais informações sobre o modelo de integração Transactions
No caso de conteúdo trafegado no modelo para API, apenas com o conteúdo da propriedade "Content" será utilizado, desconsiderando o header.
Veja abaixo o exemplo do mesmo JSON definido acima, porém atendendo ao modelo de request/response de uma API.
Mensagem Padronizada API
{
"CompanyId": "1",
"BranchId": "B1",
"CompanyInternalId": "CompanyInternalId",
"InternalId": "InternalId",
"Code": "Code",
"Description": "Description",
"NatureType": "NatureType",
"UseCategory": "UseCategory",
"Blocked": 0
}
Clique aqui para obter mais informações sobre integração via API
Reutilização do Modelo
É obrigatório que, ao utilizar os dois modelos de integração disponíveis, o modelo de dados definido para retorno da API seja compatível com a definição da propriedade "Content", do modelo Transactions.
Definição da Mensagem no modelo JsonSchema
Abaixo encontram-se as regras para definir uma mensagem padronizada.
- Seguir a especificação do formato JsonSchema (draft 4 ou superior)
- Clique aqui para visualizar exemplos
- Seguir a definição de campos especificada
- Especificar propriedade X-Totvs de acordo com a documentação, incluindo quais ERPs implementam aquela mensagem e os campos relacionados.
- 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.
X-TOTVS
Cabeçalho (Info)
Nesse tópico entraremos em maiores detalhes da propriedade x-totvs de dentro da info (cabeçalho). Caso queira entender sobre os outros campos da info do schema, visite nosso Guia de APIs e/ou verifique como a info foi descrita em outros schemas.
O objetivo do x-totvs da info é especificar quais produtos Totvs implementaram uma determinada mensagem, e trazer outras informações sobre a mesma.
Exemplo X-Totvs Info
"info": {
...
"x-totvs": {
"messageDocumentation": {
"name": "StockTurnOver",
"description": "Baixa de estoque",
"segment": "Construção e Projetos",
"domain": "Planejamento"
},
"productInformation": [
{
"product": "RM",
"contact": "Bruno Barbosa de Souza",
"note": "GDP Inovação Const. e Proj.",
"adapter": "MovMovimentoData"
},
{
"product": "Protheus",
"contact": "Eduardo de Souza",
"note": "GDP de Materiais",
"adapter": "MATI241"
},
{
"product": "PIMS",
"contact": "José Alberto da Silva",
"note": "",
"adapter": ""
}
],
"transactionDefinition": {
"subType": "event",
"businessContentType": {
"$ref": "#/definitions/BusinessContentType",
"type": "object"
},
"returnContentType": {
"$ref": "#/definitions/ReturnContentType",
"type": "object"
}
}
}
}
MessageDocumentation
Contém nome, descrição e agrupador da mensagem (esse último definido através das propriedades segment e domain)
Campo Obrigatório
Os campos "segment" e "domain" devem ser preenchidos de forma coerente com o que já está em uso nos outros schemas e APIs de nossa base (por exemplo, deve-se manter o "case" em uso, evitando variações como "HealthCare" em uma mensagem, e "Healthcare" em outra). Para isso, visite o API Reference e verifique como o que você quer adicionar está escrito.
Clique aqui para verificar os valores disponíveis para a propriedade segment
ProductInformation
- product: produto ao qual aquelas informações do "productInformation" se referem;
- contact: contato do desenvolvedor do schema;
- note: observações referente ao produto, como regras específicas;
- adapter: adapter correspondente ao schema.
Contém lista com nomes dos produtos em que essa mensagem foi implementada, qual o seu adapter correspondente e responsável.
Campo Obrigatório
TransactionDefinition
Esse campo deve ser definido para ativar a integração dessa mensagem via transaction (EAI)
Ele contém a informação do subtype (event ou request), e quais objetos do schema correspondem ao businessContentType e returnContentType.
Ao ativá-lo dessa maneira, a propriedade "Header" será preenchida automaticamente pelo EAI, enquanto a propriedade "Content" será substituída pelo objeto configurado.
Clique aqui se existem dúvidas sobre integração via transaction
Campo Opcional
Corpo/Propriedades
O objetivo dessa propriedade é especificar quais produtos Totvs implementaram uma determinada propriedade da mensagem, e trazer informações específicas sobre aquele campo em um determinado produto.
Segue exemplo abaixo:
Exemplo X-Totvs Propriedade
Code": {
"type": "string",
"description": "Código do País",
"x-totvs": [
{
"product": "Logix",
"field": "paises.cod_pais",
"required": true,
"type": "Char",
"length": "3",
"note": "some info...",
"available": true,
"canUpdate": false
},
{
"product": "RMS",
"field": "AA1CPAIS.PAIS_COD",
"required": true,
"type": "integer",
"length": "6",
"note": "some info...",
"available": true,
"canUpdate": false
}
]
},
product
Produto a que se refere essa informação.
| Exemplos |
|---|
product: “Protheus” ou product: “RM” |
O campo "product" deve ser preenchido de forma coerente com o que já está em uso nos outros schemas de nosso repositório (por exemplo, mantendo o mesmo "case"). Para isso, visite o API Reference e verifique como o produto que você quer adicionar está escrito.
Campo Obrigatório
field
A qual tabela e campo do produto o campo da mensagem se refere.
Quando não for possível ou não for conveniente referenciar o campo, pode-se referenciar o atributo de um modelo conceitual ou intermediário.
Caso no produto este campo possa estar em mais tabela (ou modelo), explicar o funcionamento.
| Exemplos |
|---|
field: “clientes.cod_cliente” ou field: “cliente.cod_cliente para Type=Customer ou fornecedor.cod_fornecedor para Type=Vendor” |
Campo Obrigatório
required
Obrigatoriedade do campo no modelo de dados. Caso haja alguma condição deve ser descrito no campo note.
| Exemplos |
|---|
required: true required: false |
Campo Obrigatório
type
Tipo de dado do campo no produto. Importante declarar aqui o tipo de dado do campo como é conhecido no produto.
| Exemplos |
|---|
type: ‘char’ type: ‘varchar’ type: ‘number’ type: ‘decimal’ type: ‘integer’ type: ‘boolean’ |
Campo Obrigatório
length
Tamanho do campo no produto, pode ser informado apenas o tamanho ou outro texto que descreva como este tamanho funciona.
| Exemplos |
|---|
length: ‘20’ length: ‘8,2’ length: ’sempre implantado como 20, mas o cliente pode usar até 50’ |
Campo Obrigatório
note
Complemento de informações sobre o campo se for o caso, como por exemplo formato da informação, vínculo entre mensagens, escopo de dados (deve ser informado para campos que precisam respeitar uma relação específica de valores no produto, podendo ser informado aqui: 'lista fixa' ou 'valores da tabela [tabela.campo]').
| Exemplos |
|---|
"note": "1=CEI;2=CNPJ;3=CPF;4=INCRA" "note": "Campo obrigatório para o processo fiscal/TAF." "note":"Segmento Principal" |
Caso na mensagem tenha sido definida lista fixa, informar aqui a relação dos valores da mensagem com os valores do produto ou qualquer outra informação importante para descrever a representação deste conteúdo no produto em questão.
Campo Opcional
available
Indica se o campo esta implementado para o produto, para a determinada mensagem. Recebe um valor booleano:
| Exemplos |
|---|
available: true available: false |
Campo Obrigatório
canUpdate
Indica se o valor do campo pode ser atualizado na tabela. Recebe um valor booleano:
Exemplos |
|---|
canUpdate: true canUpdate: false |
Campo Obrigatório
Segmentação do modelo de dados
Partindo de um jsonSchema como base, veremos a seguir um exemplo de uma possível implementação de API usando segmentação do modelo de dados.
O modelo de dados em JsonSchema será compartilhado no repositório do Github da TOTVS e deve ser referenciado na documentação da API pela sua URL, conforme apresentado no exemplo da sessão anterior.
Para este exemplo será utilizado o modelo Contract_2_000.json, representado graficamente a seguir (clique na imagem para expandir).
Convertendo este modelo "como ele é" para o formato Json Schema, teríamos o seguinte documento (alguns elementos previstos para documentação da mensagem padronizada foram omitidos para melhor compreensão):
Entretanto, utilizar o modelo desta forma tem vários problemas como, por exemplo, na modificação do contrato, onde teríamos que enviar também as páginas (Sheet) do contrato e os itens das páginas.
Por isso, a segmentação do modelo de dados é permitida, desde que mantenha a estrutura e atributos do modelo JSON original.
Nosso modelo Json Schema poderia ser segmentado em 3 submodelos:
- ContractModel, correspondente ao cabeçalho do contrato.
- SheetModel, correspondente às folhas do contrato.
- ItemModel, correspondente aos itens vinculados às folhas do contrato.
Convertendo isso para o modelo Json Schema, teríamos o seguinte, lembrando que elementos como as tags de documentação foram omitidos por questões didáticas.
Consequentemente, esta segmentação será refletida nos endpoints das APIs. Tomando por base a divisão realizada, teríamos o seguinte template:
/api/{agrupador}/v1/contracts/{ContractUniqueId}/sheets/{SheetNumber}/items/{ItemCode}
Neste template, temos as seguintes considerações:
- O item ContractUniqueId deve ser um identificador único, já que a entidade Contract prevê uma chave composta. A forma como esta chave será representada ficará a cargo da área de negócio definir. Neste exemplo específico, poderiamos assumir a concatenação dos atributos ContractNumber e ContractReview, separados por "|". Ex: 1|1.
- No nível de contracts utilizamos o submodelo ContractModel. Nos atributos ListOfSheet e ListOfItem, utilizamos os submodelos SheetModele ItemModel quando os mesmos forem expandidos.
- No nível de sheets, utilizamos apenas o submodelo SheetModel. O modelo ItemModel será utilizado quando o atributo ListOfItem for expandido.
- No nível de items, utilizamos apenas o submodelo ItemModel.
- Observe a equivalencia entre o item do modelo e o item de path correspondente:
- ListOfSheet (atributo de ContractModel) equivale a sheets.
- ListOfItem (atributo de SheetModel) equivale a items.
Nos exemplos a seguir veremos a utilização dos possíveis endpoints e seus respectivos modelos:
Inclusão de um contrato de forma completa
Inclusão de um contrato sem folhas (se a regra de negócio permitir)
Recuperando contratos (apenas cabeçalho, 1a página, até o limite de uma página)
Recuperando um contrato, expandindo os atributos ListOfSheet e ListOfItem
Incluindo uma folha no contrato
Incluindo um item de uma folha do contrato
Eliminando um item de uma folha
- DELETE /v1/contracts/1|1/sheets/1/items/1
Eliminando uma folha de um contrato
- DELETE /v1/contracts/1|1/sheets/1
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
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas