Histórico da Página
...
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:
...
- 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.
...
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
"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"
}
}
}
} |
...
Contém nome, descrição e agrupador da mensagem (esse último definido através da propriedade das propriedades segment e domain)
Campo Obrigatório
| Aviso |
|---|
O campo Os campos "segment" e "domain" deve devem ser preenchido 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 segmento que você quer adicionar está escrito. |
...
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
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas