Eteg

Como o uso da API pode dar mais poder ao seu site

Ludmila Gonzaga |

O que é API de um site?

A sigla API refere-se ao termo em inglês “Application Programming Interface” que significa em tradução para o português “Interface de Programação de Aplicativos”. Esta interface de programação é um conjunto de padrões de programação que permitem a construção de aplicativos e a sua utilização. 

Uma API é criada quando uma empresa de software tem a intenção de que outros criadores de software desenvolvam produtos associados ao seu serviço. Existem vários deles que disponibilizam seus códigos e instruções para serem usados em outros sites da maneira mais conveniente para seus usuários.

Uma de suas características interessantes é o fato de oferecer uma interface de comunicação de rápido acesso padronizado. Possibilitando pegar os dados que estão no sistema interno de uma empresa e disponibilizando-os para o mundo externo, de forma segura, gerenciável e escalável. 

O Google Maps é um dos grandes exemplos na área de APIs. Por meio de seu código original, muitos outros sites e aplicações utilizam os dados do Google Maps adaptando-o da melhor forma a fim de utilizar esse serviço. 

Pense no seguinte exemplo: o uso de energia elétrica em sua casa ou apartamento. Quando você deseja utilizar um eletrodoméstico, você precisa somente ligar o aparelho na tomada. Não é preciso conectar diretamente o fio do aparelho diretamente na caixa de luz. Isso seria, além de muito ineficiente, difícil e perigoso de ser feito (caso você não seja eletricista). 

 

plug de tomadas exemplo api
Overloaded plug socket por The Clear Communication People

Quais os benefícios de fazer integração via API?

As APIs facilitam muito essa rotina, e para cumprirem essa premissa, elas devem ser realmente funcionais.

Integrar sistemas via API é capaz de trazer diversos benefícios para o desempenho de uma empresa, como:

  • Automação de ações, como: disparos de cobranças, baixa de estoque, fluxo de vendas e muitas outras; com uma consequente redução de custo de mão de obra;
  • Terceirização de sistemas: menos custos operacionais dentro da área de TI da empresa e uma gama de sistemas mais avançados e atualizados;
  • Facilidade de gerenciamento de processos;
  • Integração entre áreas da empresa, como vendas, marketing e logística;
  • Data driven: melhor uso, armazenamento e processamento de dados;
  • Segurança da informação.

Portanto, contratar uma ferramenta com integração via API é algo que, por si só, não quer dizer nada. O importante é que essa API seja amigável, bem documentada, flexível e fácil de realizar. 

Como Verificamos a Qualidade de uma API?

O primeiro objetivo da engenharia é produzir sistemas funcionais. Uma API também precisa ser fácil de usar, largamente adotada e produtiva. Uma abordagem de engenharia precisa de uma maneira objetiva de medir a qualidade de seus produtos. Assim, precisamos formular isso para cada API para que possamos medir o grau que um determinado objetivo seja satisfeito. 

 Compreensibilidade

Aqueles que usam uma API devem ser capazes de entendê-la. Uma API é uma comunicação entre o programador que escreve a API e o programador que escreve uma implementação usando esta API. Os conceitos da API devem estar dentro do horizonte dos usuários da API, ou eles não entenderão. O projetista da API deve entender qual é o conhecimento comum dos seus usuários e usar esse conhecimento quando projetar a API. 

Uma atividade bastante similar a escrever uma API é escrever um livro, pois temos um escritor e diversos leitores. Os leitores sabem alguma coisa do escritor, mas o escritor sabe pouco ou nada sobre os seus leitores. Adivinhar suas habilidades e conhecimentos corretamente faz parte da delicada arte de fazer uma API que é fácil de entender

Consistência

Outro aspecto muito importante de uma API que sempre devemos levar em consideração é se ela é consistente. É sempre importante mantermos o estilo de desenvolvimento ou pelo menos comunicar claramente evoluções no estilo da API. É inconveniente que certas partes da API evoluíram de diferentes formas que as outras. 

Descoberta

Um ponto importante é que na maioria dos casos, o conjunto de classes disponibilizado pela API não é o que interessa a maioria dos usuários da API. Eles estão interessados em realizar o seu trabalho. Para isso é mais importante para eles ver exemplos de uso da API, e se possível permitindo a seleção do idioma que está mais próximo do que ele quer fazer. Isso explica o sucesso de projetos open source, pois normalmente podemos simplesmente copiar fontes existentes para começar. O código fonte pode servir como documentação e pode fornecer uma orientação inicial.

Dessa forma, é sempre importante criar um lugar único que pode servir como um ponto de início e pode enviar pessoas na direção correta para solucionar seus problemas.

Facilitando Tarefas Simples

A abordagem mais correta é dividirmos uma API em duas ou mais partes: uma parte é direcionada para os que “chamam” a API, a outra parte de preferência em um pacote ou namespace separado, para aqueles que fornecem plugins na API para que possam fornecer seus serviços ou extensões. Um exemplo dessa abordagem está na API JNDI em que os projetistas separaram as interfaces para públicos diferentes, separando-a em pacotes completamente diferentes. Os chamadores da API usam “javax.naming” e “javax.naming.event”, enquanto que os implementadores estão mais interessados no “javax.naming.spi”.

Este tipo de separação é mais importante do que documentar a API. Os diferentes públicos da API podem focar seus estudos e conceitos nas suas áreas de interesse

Preservação do Investimento

Para tornar-se um usuário de uma biblioteca precisamos entendê-la e nos convencermos de que ela economiza trabalho. Além disso, os usuários de uma API precisam acreditar que o trabalho deles não será interrompido ou que vai desaparecer quando uma nova versão da API for lançada. Codificar para uma biblioteca é um investimento de tempo, estudo, esforço e dinheiro. Assim, a primeira e principal responsabilidade do projetista da API é preservar o investimento daqueles que a usam. 

Como vimos, a API liga as diversas funções em um site de maneira que possam ser utilizadas em outras aplicações. E no seu negócio, já é feito a integração de sistemas via API?

Caso tenha alguma dúvida, deixa aqui nos comentários ou entre em contato com a gente!

Quer acessar este conteúdo a qualquer momento?