Histórico da Página

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

...

Uma Interface de Programação de Aplicações é uma coleção de informações padronizadas estabelecida por um software que possibilita a utilização de suas funcionalidades por outros aplicativos. Com as informações persistidas em uma especificação de API, é possível enviar ou receber dados de uma aplicação sem que seja necessário entrar nos detalhes da implementação deste programa.

É de grande interesse para a TOTVS que aplicações externas consigam se comunicar com seus produtos de maneira facilitada. Por meio da implementação de uma API, é possível que outras aplicações obtenham dados internos dos produtos TOTVS, apenas enviando uma requisição HTTP para o endereço devidamente descrito na especificação da API.

Para descrever uma API, se faz necessária uma especificação padronizada. O padrão utilizado para a construção das APIs TOTVS é o OpenAPI 3.0, o qual descreve um formato para definição de toda a API. Essa especificação é que define como serão evidenciados os endpoints e seus métodos, parâmetros de operações de entrada e saída, métodos de autenticação, metadados (tais como informações gerais, contato, licença e termos de uso), entre outros.

Criação de uma API

 As regras para o desenvolvimento de APIs estão especificadas no nosso Guia de Implementação de APIs.

Todas as APIs já desenvolvidas podem ser encontradas em nosso repositório do GitHub.

Diferenciação entre API e Schema

Uma API não deve ser confundida com um schema. As APIs são interfaces que definem os métodos e caminhos que permitem a comunicação entre dois pontos. Já o schema é uma forma de apresentar dados e seus tipos, permitindo a comunicação

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.

...