Histórico da Página
...
Para uma melhor apresentação visual das APIs, foi desenvolvido criado o portal API Reference, onde todas as APIs desenvolvidas pelos segmentos TOTVS e aprovadas pelo comitê podem ser encontradas.
...
x-totvs dentro da "info":
O exemplo a seguir é um trecho da API UnitOfMeasure v2.
| Bloco de código |
|---|
"info": {
"description": "API para informações de Unidade de Medida para Unidade de Medida TOTVS",
"version": "2.000",
"title": "UnitOfMeasure",
"contact": {
"name": "T-Talk",
"url": "api.totvs.com.br",
"email": "[email protected]"
},
"x-totvs": {
"messageDocumentation": {
"name": "UnitOfMeasure",
"description": "Cadastro de Unidade de Medida",
"segment": "Serviços"
},
"productInformation": [
{
"product": "Protheus",
"contact": "[email protected]",
"description": "Cadastro de Unidade de Medida",
"adapter": "QIES030.prw"
},
{
"product": "Logix",
"contact": "[email protected]",
"description": "Cadastro de Unidade de Medida",
"adapter": ""
}
]
}
}
|
A propriedade "messageDocumentation" do "x-totvs" traz informações sobre a própria API.
- name: título da API
- description: descrição da API
- segment: segmento da TOTVS pelo qual aquela API foi implementada
...
x-totvs dentro dos métodos/verbos dos "paths"
O exemplo a seguir também é um trecho da API UnitOfMeasure v2.
Identificar se o produto a ser integrado já está definido na documentação da API
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas