Com o objetivo de funcionar como uma interface de programação de aplicações, a API facilita a troca de informações entre dois softwares, onde um é responsável por levar dados e o outro recebe e os interpreta. Configurada em diferentes métodos, a API permite que sistemas operacionais sejam associados a outros.

API – configuração e conceito

Para que a integração entre a plataforma Flexy e outros sistemas (ERP’s, CRM’s etc) possam acontecer, disponibilizamos a documentação API dentro do painel administrativo de sua loja.

A documentação é direcionada aos técnicos de integração e pode ser acessada no painel administrativo da plataforma. Disponível em Menu > Configurações > API. Ao acessá-la, sua equipe técnica encontrará todas as informações e regras necessárias para que um sistema se integre com a plataforma Flexy.

Através da API, você consegue automatizar processos do seu modelo de negócio, utilizando métodos de obtenção de dados. Para realizá-lo, a API da Flexy disponibiliza quatro tipos de requisições; método para extrair dados (GET), cadastro de novas informações (POST), atualização de dados (PUT) e deleção de elementos (DELETE). Atente-se que, para obter as informações, tais requisições devem ser configuradas em seu ERP.

A fim de explicitar os métodos, utilizamos alguns casos de funcionalidades práticas. Por exemplo, quando necessária a alteração de status de um pedido (pedido enviado, pedido entregue etc.), deve ser utilizado o método PUT. Qualquer atualização deste produto feita no ERP deve ser automatizada para ser replicada na Flexy, também via PUT.

Caso os pedidos do seu e-commerce sejam realizados em um sistema externo, então devem ser postados na plataforma Flexy via método POST.

Se houver a necessidade de listar os clientes cadastrados na plataforma, utilize o método GET. Atente-se ao limite de dados que a requisição trará, assim como as informações provenientes dela.

Quando necessitar excluir pedidos via API, utilize o método DELETE. Exclua o pedido de acordo com o número dele enviado, lembre-se que somente administradores do shopping podem excluir um pedido.

Todas as contas possuem um pacote mensal de requisições. Atente-se e programe o seu sistema para não exceder a quantidade contratada, uma vez que um valor adicional é cobrado. Em seu contrato, verifique o pacote contratado.

Transferência de Dados (DE > PARA)

A integração entre outros sistemas e a Flexy pode acontecer em dois fluxos:

• Do ERP (ou demais sistemas) para a Flexy (envios API)

           e/ou

• Da Flexy para o ERP (via webhooks).

Exemplos:

• A Flexy aceita apenas receber requisições protegidas com HTTPS. Alguns ERPs podem não estar aptos a enviar requisições desse tipo. Neste caso, para integrar informações do ERP à plataforma Flexy, é necessária a utilização de um middleware de integração que transforme as URLs de requisição DE http (por exemplo) PARA https.
• Para cadastrar clientes, é necessário que a integração envie campo de nome (firstName) e sobrenome (lastName) para a Flexy. Digamos que no sistema de ERP o nome esteja apenas em um campo "nome completo", então o middleware deve transformar DE nome completo PARA primeiro nome e segundo nome.

Para maiores detalhes consulte a documentação da API disponível no painel administrativo da loja. 

O que são e como habilitar Webhooks

O webhook é a nossa ferramenta de integração que dispara informações da Flexy para um sistema externo após algum evento, permitindo que a integração entre os sistemas aconteça em tempo real.

Na prática, o webhook executa o fluxo inverso da postagem de informação feito pela API, ou seja, neste caso, a Flexy envia as informações que foram realizadas para o sistema externo, funcionando ativamente no envio de dados.

Exemplo: O webhook de fechamento de pedido, quando habilitado, irá disparar uma requisição com todos os detalhes do pedido para a URL de destino cadastrada, assim que a compra em questão for finalizada. E, por fim, o sistema integrado irá receber e interpretar tais informações.

A plataforma Flexy possui 9 ações como essa passíveis de disparos de webhooks para links externos, sendo que duas delas são válidas apenas para contas marketplaces. São:

• Fechamento de pedido;
• Alteração de status de pedido;
• Cadastro de cliente;
• Alteração de cliente;
• Newsletter;
• Processamento de imagem;
• Mensagens;
• Loja criada (marketplaces)
• Loja atualizada (marketplaces)

Para habilitar o webhook de alguma das ações acima, acesse o painel de sua loja em Menu > Configurações > API.

Os disparos de requisições via webhook ficam registrados em um histórico dentro desta mesma área do painel, em que é possível visualizar a requisição enviada e seu log, assim como possíveis mensagens de erro.

Estas foram algumas dicas de como configurar e utilizar a API. Caso sua equipe técnica tenha dúvidas de como utilizá-la, peça para que entrem em contato via Central de Ajuda Flexy.