Índice |
---|
A Mensagem Padronizada TOTVS estabelece alguns padrões que devem ser seguidos por todos os aplicativos que participam da integração. Estes padrões estabelecem alguns tipos de mensagens suportadas bem como informações obrigatórias que devem fazer parte do seu conteúdo.
...
Clique aqui para obter mais informações sobre integração via API
Abaixo encontram-se as regras para definir uma mensagem padronizada.
Âncora | ||||
---|---|---|---|---|
|
O objetivo dessa propriedade é especificar quais produtos Totvs implementaram uma determinada propriedade da mensagem, e trazer outras informações sobre a mesma.
Bloco de código | ||||
---|---|---|---|---|
| ||||
"info": { ... "x-totvs": { "messageDocumentation": { "name": "StockTurnOver", "description": "Baixa de estoque", "segment": "Construção e Projetos" }, "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" } } } } |
Contém nome, descrição e agrupador da mensagem (esse último definido através da propriedade segment)
Clique aqui para verificar os valores disponíveis para a propriedade segment
Campo Obrigatório
Contém lista com nomes dos produtos em que essa mensagem foi implementada, qual o seu adapter correspondente e responsável.
Campo Obrigatório
Esse campo deve ser definido para ativar a integração dessa mensagem via transaction (EAI)
...
Clique aqui se existem dúvidas sobre integração via transaction
Campo Opcional
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.
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
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 } ] }, |
Nome do produto TOTVS do qual as outras informações se referem
Campo Obrigatório
Define se essa propriedade está ou não disponível
Campo Obrigatório
Define se essa propriedade pode ser atualizada
Campo Obrigatório
A qual tabela.campo o campo da mensagem se refere.
Caso no produto este campo possa estar em mais tabela, explicar o funcionamento.
Campo Obrigatório
Obrigatoriedade do campo, ou condições em que ele será obrigatório ou não.
Campo Obrigatório
Tipo do campo no produto. Importante declarar aqui o tipo do campo como é conhecido no produto.
Campo Obrigatório
Tamanho do campo no produto, pode ser informado apenas o tamanho ou outro texto que descreva como este tamanho funciona.
Campo Obrigatório
Complemento de informações sobre o campo se for o caso.
Campo Opcional
Âncora | ||||
---|---|---|---|---|
|
Json Schema da Mensagem Branch 2.001 : https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_001.json
...
Exemplos Oficiais site json-schema: https://json-schema.org/learn/miscellaneous-examples.html
Âncora | ||||
---|---|---|---|---|
|
http://docs.oasis-open.org/ubl/prd1-UBL-2.1/UBL-2.1.html
...