Desenvolver uma integração nunca é uma tarefa fácil, mas diversos aspectos da API de integração podem facilitá-la, ou dificultá-la.

Nessa área um TRADE OFF sempre irá existir, entre 1) facilidade na utilização da API de integração, 2) custo de infraestrutura da empresa que irá manter a API e 3) controle dos dados que estão sendo inseridos. Ao desenvolver uma API para integração, a empresa terá que optar em qual das pontas deste triângulo sua integração estará focada.

triângulo

 

Na Plugg.To, nosso objetivo desde o início foi criar a API mais fácil possível para integração, ao mesmo tempo oferecendo grande escalabilidade e flexibilidade para se trabalhar com infinitas regras de negócio que funcionariam desde pequenas a grandes contas.

O protocolo escolhido foi o REST SERVICE, que é mais utilizado atualmente no mercado, isso porque é de fácil aprendizado, tem suporte em todas as linguagens, e suas mensagens podem ser em JSON, que foi nosso formato de mensagens escolhido por ser igualmente traduzido facilmente para todas as linguagens.

Até aí, não há muita diferença com o restante das APIs do mercado. O que torna a API realmente muito rápida a ser desenvolvida é a forma que as informações são cadastradas e obtidas.

Demonstraremos isso utilizando o cadastro de um novo produto:

Para realizar este cadastro na maioria das plataformas e ERPs, primeiramente é necessário cadastrar as categorias as quais o produto pertence, em seguida todos atributos que irá ter, para só depois conseguir cadastrar o produto em si. Caso o produto possua variações, após o cadastro do produto ainda é necessário cadastrá-las.

API1

Veja a quantidade de chamados que até agora já foram feitas: Uma para cada categoria, uma para cada atributo, uma para cada variação, alguns continuam ainda com cadastros de fotos, marcas, estoque, preço…. E por aí vai.

Na API da Plugg.To qualquer cadastro ou alteração de produto é realizado por uma ÚNICA chamada, e o melhor, o desenvolvedor não precisa se preocupar se o produto é novo ou se está apenas sendo atualizado, a API é inteligente o suficiente para identificar a situação atual do produto. Isso porque o código SKU funciona campo chave de todo sistema, se ele existe, será atualizado, se não criado.

API2

Para ler um produto a tarefa é igualmente fácil, uma única chamada já retorna todas suas informações, sendo possível ainda ler até 100 produtos por chamada.

É uma tarefa extremamente fácil saber o que foi atualizado, tanto um produto, quanto um pedido. Além ser possível pesquisar produtos/pedidos pela hora da última atualização, todas atualizações na API geram uma notificação (mensagem que é enviada para todos sistemas integrados), dessa forma a aplicação recebe todas as alterações realizadas imediatamente, e o melhor, evita gastos de infraestrutura com chamadas desnecessárias de busca de informação.

O retorno da API tanto de produtos quanto de pedidos devolve todos os campos disponíveis, mesmo aqueles que não foram preenchidos, sendo fácil descobrir quais campos podem ser utilizados.

A documentação da API foi criada utilizando o POSTMAN, que oferece um plugin para Chrome, onde o desenvolvedor poderá testar de forma fácil as funcionalidades da API disponível com exemplos prontos.

E para finalizar, o mais legal de tudo é que a API disponibilizada para desenvolvedor externos e outras empresas é a mesma utilizada por todo o sistema, então desenvolvedores internos e externos sempre contam com as mesmas funcionalidades.