Histórico da Página

...

Para uma melhor apresentação visual das APIs, foi desenvolvido o portal API Reference, onde todas as APIs desenvolvidas pelos segmentos TOTVS e aprovadas pelo comitê podem ser encontradas.

...

A propriedade "x-totvs"

<Tópico pendente de informação>

O objetivo do x-totvs é evidenciar informações pertinenetes aos produtos TOTVS.

Vincula o arquivo OpenAPI aos produtos TOTVS. Informações necessárias. Mostrar os campos, preenchimento de cada um, etc.

...

A propriedade x-totvs nas APIs traz diferentes informações dependendo da seção em que ela está localizada no OpenAPI, porém com um objetivo em comum: armazenar dados pertinentes aos produtos TOTVS. São nas propriedades x-totvs ao longo do documento que são especificadas informações como: nome do produto ao qual se refere, segmento ao qual está vinculado, adapter atrelado, se determinado verbo está disponível, entre outros.

A propriedade x-totvs pode estar presente em diferentes seções do OpenAPI

Implementação de APIs com Mensagem Padronizada

x-totvs em diferentes partes do OpenAPI

• x-totvs dentro da "info":

  O exemplo a seguir é um trecho da API UnitOfMeasure v2.

"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

 Já a propriedade "productInformation" traz informações sobre os produtos TOTVS.

• • product: produto ao qual aquela informações do "productInformation" se referem.
  • contact: e-mail para contato com quem desenvolveu aquela API naquele determinado produto.
  • description: descrição da API para aquele determinado produto
  • adapter: adapter que se comunica com aquela determinada API
  • A propriedade "productInformation" poderia ter ainda a tag helpUrl, que contém um link para a documentação daquela API para aquele produto, caso haja.

• 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

...