A integração entre sua aplicação e a plataforma de e-commerce da BW Commerce é feita através de um web service. Esse web service foi criado seguindo o estilo arquitetural REST. Ou seja, de forma resumida, sua aplicação deverá fazer requisições para nossa API REST utilizando o protocolo HTTP. Para fazer estas requisições HTTP, existem bibliotecas para as mais diversas linguagens de programação. Alguns exemplos estão listados abaixo:

• Curl, para PHP
• Unirest, para Java
• RestSharp, para C#
• Pacote HTTP, para Node.js
• Net::HTTP, para Ruby
• Requests, para Python
• Pacote http, para GO
• TNetHTTPClient, para Delphi

A partir do uso dessas bibliotecas (ou de outras de acordo com sua escolha e necessidade), você poderá disparar requisições HTTP que farão o envio dos dados da sua aplicação para nossa API, a qual encaminhará os dados para os bancos de dados da plataforma de e-commerce da BW Commerce. O cenário mais comum é obter as informações no banco de dados da sua aplicação, converter essas informações de acordo com as nossas estruturas de dados (veja a seção 5, ela fala sobre as estruturas de dados mais detalhadamente), fazer o envio dessas informações convertidas através de requisições HTTP e obter seu retorno.

Nossa API de integração foi desenvolvida especificamente para que sistemas de gestão (ERP) integrarem com a plataforma da BW Commerce.

Se você deseja integrar uma outra solução em nossa plataforma, recomendamos que entre em contato com nossa equipe de parcerias para seu produto e avaliar outras possibilidades de integração da sua solução. Você pode fazer isso enviando um e-mail para parceiros@bwcommerce.com.br.

A api de integração possui um limite de 180 requisições por minuto para cada endereço de IP requisitante.

A API de integração está disponível apenas para uso no Brasil e nos Estados Unidos. Requisições originadas de outros países não serão processadas e retornarão um erro HTTP 403 (Forbidden).

A conexão deve ser realizada via HTTPS e deve seguir a política de segurança TLSv1.2_2021, garantindo o uso de TLS 1.2 ou superior e conjuntos de cifragem modernos e seguros.

Como já mencionado, nosso web service é uma API REST acessada por requisições utilizando o protocolo HTTP. Sendo assim, a API não é capaz de guardar estados, consequentemente, é necessário que em toda requisição performada seja feita a autenticação novamente.

Para fazer a autenticação em nossa API REST, você precisará gerar um Token. O token poderá ser gerado pelo painel administrativo no aplicativo de tokens de acesso, ou solicitando a nossa equipe quando o ambiente de testes for liberado (veja a seção 2, ela fala sobre a obtenção de um ambiente de testes). De forma resumida, você deverá informar o token gerado no cabeçalho Token. Nesse link você pode verificar exemplos de autenticação utilizando cURL e Postman.

Veja o exemplo abaixo utilizando a linguagem de programação PHP.

   //Autenticacao por token
   $token = teste123465789teste123465789teste13246579;
   
   // Adiciona o prefixo Token ao cabeçalho
   $cabecalho = sprintf('Token %s', $token);

   // Saída Token teste123465789teste123465789teste13246579
   echo $cabecalho . PHP_EOL; 

Entre em contato conosco através dos nossos canais de atendimento:

• Central de Ajuda: Acesse nossa central de ajuda e encontre respostas para dúvidas frequentes.
• Conversar com Suporte: Fale com nosso time de suporte via WhatsApp.
• Acessar Grupo: Participe do nosso grupo no WhatsApp e fique por dentro das atualizações da API.

Se você é um parceiro ou tem interesse em se tornar um parceiro BW Commerce, acesse nosso portal:

• Portal de Parceiros