Conceito

...

Uma API - (acrônimo de Application Programming Interface, ou  ou Interface de Programação de Aplicação em português - ) é um conjunto de rotinas e padrões estabelecidos por um software para a utilização das suas funcionalidades de seus recursos por aplicativos que não pretendem envolver-se em detalhes da implementação do software, mas apenas usar seus serviços. De modo geral, a uma API é composta por uma série de funções acessíveis somente por programação e que permitem utilizar características do software menos evidentes ao utilizador usuário tradicional.

...

...

Desenvolvimento

...

Para o correto desenvolvimento é preciso ter em mente alguns cuidados que devem ser sempre considerados na construção de uma API:

• Nunca desenvolva ou solicite

...

• qualquer interação com o usuário

...

• , seja ela através de telas, mensagens ou perguntas

...

• ;
• Simplifique suas funções, não é uma boa prática construir uma função "faz tudo", separe sempre sua lógica em diversas funções que possam ser executadas de formas distintas;
• Evite que suas funções dependam do produto, lembre-se que elas poderão ser executadas através de outros produtos ou serviços; e
• Sempre desenvolva visando a solução de único objetivo de negócio. Uma API para manutenção de pedidos não pode conter manutenção de

...

• empresas, por exemplo.

Nos próximos itens deste documento, serão detalhadas as técnicas que devem ser seguidas na construção do código fonte da API.