API

Bem-vindo ao guia da API Get Commerce! Este guia foi criado para ajudar você a entender o que é uma API e como disponilizá-la à sua equipe técnica para que estes possam utilizar os recursos da mesma.

📍 O que é uma API?

API significa Interface de Programação de Aplicativos. É uma maneira para diferentes sistemas se comunicarem entre si. Simplificando, é como um conjunto de regras que permite que um aplicativo ou sistema solicite e receba informações de outro.

Nossa API permite que sistemas externos acessem e utilizem recursos da sua loja Get Commerce de forma programática e segura. Alguns recursos disponíveis:

- Busca de pedidos; - Criação de produtos.

📍 Como gerar o Token da API

Para que seu time técnico/sistema externo consiga acessar estes recursos, é necessário que um aplicativo de API seja criado em sua plataforma Get Commerce. Este aplicativo irá intermediar a conexão entre a Get Commerce e seu sistema, armazenando informações sobre a troca de dados entre os sistemas e o token que deverá ser utilizado pelo sistema para autorizar estas trocas. Mas calma, o processo é bem simples! Para criar um novo aplicativo e gerar seu token, basta seguir o passo a passo abaixo 😄

Com sua plataforma Get Commerce aberta, navegue até a aba Configurações > Api > Meus Apps. Nesta aba serão listados todos os Apps de Api cadastrados em sua loja:

Com o token em mãos, o sistema externo já poderá utilizar os recursos da API!

Documentação técnica da API

Para acessar a documentação técnica da API, acesse o link: https://getcommerce.readme.io/

📍Callbacks

Se você notar, dentro do aplicativo de API criado há uma aba chamada "Callbacks":

Callbacks são uma forma da Get Commerce comunicar ao seu sistema externo, de forma automática, que uma alteração foi realizada dentro de sua loja virtual.

Por exemplo, o callback "Estoque de Produto" irá enviar uma notificação ao seu sistema externo sempre que o estoque de um produto for alterado em sua loja Get Commerce!

Para configurá-los é muito simples! Você apenas precisará colar a URL (que será informada pelo seu sistema externo) no devido campo de callback e tudo já estará funcionando! 😄

Last updated