Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice


O que é uma API? 

...


Criação API

Introdução + openapi + guia de APIs

http://tdn.totvs.com/display/public/INT/Guia+de+implementacao+das+APIs+TOTVS

Diferenciação entre

...

API e Schema

Justificar quebra entre dois arquivos distintos. Reusabilidade. Pessoa pode usar o protocolo transactions e se comunicar utilizando apenas schema. Caso outra aplicação necessite, consegue se comunicar através das APIs, seguindo padrão OpenAPI.

API é o contrato, traz informações importantes que definem os moldes das mensagens trafegadas. API Reference mostra as APIs, não os schemas

Schema são as mensagens padronizadas propriamente ditas. Trazem as definições dos types, binda com os produtos totvs através do x-totvs.

Os arquivos que especificam 

Identificar se o produto a ser integrado já está definido na documentação da API

...

O que é a propriedade "x-totvs"

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


Editar "x-totvs" da API

Caso a api já exista mas não para seu produto, significa que você precisa aadaptar a API ao seu produto.

Adicionar novo produto, especificação de adapters etc etc