Conectar a B2BGateway: pedidos de entrada, envios e faturas de saída por EDI

Solicite a URL base à sua equipe de conta da B2BGateway, copie a chave API da sua conta da B2BGateway, cole as duas no Integration, teste, mapeie cada parceiro comercial e ative: entram mensagens de pedido e saem mensagens de envio e fatura.

O conector da B2BGateway troca documentos EDI com seus parceiros comerciais por meio da B2BGateway: as mensagens de ordem de compra chegam dos parceiros e viram pedidos, e as mensagens de envio e fatura voltam para os mesmos parceiros. Não é uma conexão de loja: tudo é organizado por parceiro comercial e por tipo de documento, então cada parceiro é configurado e verificado separadamente.

Pré-requisitos#

• Uma conta da B2BGateway. A URL base não é um endereço público que você procura por conta própria: sua equipe de conta da B2BGateway a fornece para a sua conta.
• Acesso à chave API dessa conta da B2BGateway, ou um contato que possa fornecê-la. A chave é enviada como cabeçalho X-API-Key em cada solicitação.
• Pelo menos um parceiro comercial para trocar documentos por meio da B2BGateway. Esta conexão não cria o parceiro para você: o lado do parceiro na troca precisa existir antes que as mensagens dele possam fluir.
• Na primeira conexão, prove primeiro a configuração com uma mensagem de teste de um parceiro; nunca teste um mapping novo com documentos reais de um parceiro.

Obter credenciais#

1. Solicite à sua equipe de conta da B2BGateway a URL base da API para a sua conta e copie-a exatamente como ela for entregue. Ela começa com https://: se o endereço parecer incompleto, peça a confirmação em vez de adivinhar o restante.
2. Obtenha a chave API da sua conta da B2BGateway. Se não a encontrar na conta, pergunte à sua equipe de conta da B2BGateway onde a sua conta a exibe; não reutilize uma chave de outra conta.
3. Guarde os dois valores juntos: a URL base diz com onde a conexão fala e a chave API prova que é a sua conta. Você precisará dos dois na próxima etapa.

Preencher no Integration#

1. Abra Integration → Marketplace → B2BGateway → Nova conexão.
2. URL base (obrigatório): cole a URL base da API da B2BGateway que sua equipe de conta lhe deu, por exemplo https://… Copie o endereço completo exatamente: um caractere faltando, um espaço extra ou um endereço de outra conta farão o teste da próxima etapa falhar, mesmo que a chave API esteja correta.
3. Chave API (obrigatório): cole a chave API da sua conta da B2BGateway. Ela é enviada como cabeçalho X-API-Key quando a conexão fala com a B2BGateway. É guardada como segredo, criptografada em repouso, e nunca é exibida novamente após salvar.
4. Salve a conexão, mas não a ative ainda. Teste-a primeiro e depois faça o mapping de parceiros comerciais: uma conexão com as credenciais corretas, mas sem mapping de parceiros, não consegue mover nenhum documento.

Testar a conexão#

Clique em Testar a conexão. O teste fala com a URL base que você preencheu e apresenta sua chave API como cabeçalho X-API-Key, então verifica o endereço e a chave juntos: se passar, a B2BGateway respondeu e aceitou a chave da sua conta. Depois execute a prévia em nível de documento com uma mensagem de pedido real de um parceiro comercial, para ver os campos do parceiro ao lado do pedido padrão antes de qualquer coisa entrar em produção. Se nenhum parceiro tiver enviado uma mensagem de teste ainda, peça ao parceiro — ou à sua equipe de conta da B2BGateway — que envie uma primeiro; a prévia precisa de uma mensagem real. Se o próprio teste falhar, use as perguntas frequentes: descubra se a culpa é da URL base ou da chave API antes de mudar as duas de uma vez.

Mapping / escolher modelo#

Na B2BGateway, o mapping é por parceiro comercial, não uma única configuração para toda a conexão. Para cada parceiro, escolha o modelo daquele parceiro e verifique os tipos de documento que você troca com ele: mensagens de pedido de entrada e mensagens de envio e fatura de saída. Na prévia, verifique se os identificadores do parceiro, os números de item, as quantidades e os dados de entrega caem nos campos corretos do pedido padrão, e se seus dados de envio e fatura são mapeados de volta para os campos que aquele parceiro espera. Parceiros não compartilham um mesmo mapping: um parceiro com o mapping pronto pode entrar em produção enquanto outro ainda está sendo configurado, e um parceiro novo sempre precisa da sua própria verificação de mapping antes do primeiro documento real.

Ativar#

Após ativar, as mensagens de pedido dos seus parceiros comerciais mapeados entram como pedidos e, depois que esses pedidos são enviados, as mensagens de envio e fatura voltam ao parceiro por meio da B2BGateway. Acompanhe os primeiros documentos de cada parceiro em Runs / Logs: um parceiro ainda não mapeado não trocará documentos, então verifique separadamente o primeiro pedido, o primeiro envio e a primeira fatura de cada parceiro antes de confiar na conexão sem supervisão.

Perguntas frequentes#

O teste falha: a chave API é rejeitada

A chave API preenchida na conexão não corresponde à chave da sua conta da B2BGateway. A chave viaja como cabeçalho X-API-Key, então um único caractere errado ou faltando, um espaço no final ao colar, ou uma chave que pertence a outra conta da B2BGateway são lidos da mesma forma pela B2BGateway: não é a sua chave.

Obtenha a chave API novamente da sua conta da B2BGateway — pergunte à sua equipe de conta onde a conta a exibe, se não a encontrar — cole-a no campo de chave API sem nada antes ou depois, salve e teste de novo. Não mude a URL base ao mesmo tempo, para poder saber qual correção funcionou.

O teste falha: a conexão não alcança a B2BGateway

A URL base preenchida na conexão está incorreta, então a solicitação nunca chega ao endereço certo da B2BGateway para a sua conta. É a causa habitual quando o endereço foi digitado à mão, encurtado ou copiado de outra conta: a chave API pode estar perfeita e o teste mesmo assim não passa.

Peça à sua equipe de conta da B2BGateway que confirme a URL base exata da API para a sua conta, substitua o campo de URL base por esse endereço copiado inteiro — começando com https:// e sem acrescentar nem remover nada — salve e teste de novo.

O teste passa, mas os documentos de um parceiro comercial não fluem

O mapping daquele parceiro comercial ainda não foi configurado, ou não foi concluído. O teste de conexão só prova que o endereço e a chave API estão certos: os documentos se movem por parceiro, então um parceiro sem um mapping completo não tem com o que converter suas mensagens de pedido, nem por onde enviar suas mensagens de envio e fatura, mesmo que outros parceiros da mesma conexão funcionem bem.

Abra a etapa de Mapping para esse parceiro, escolha o modelo do parceiro, mapeie os tipos de documento que você troca com ele — pedidos de entrada, envios e faturas de saída — e execute a prévia de documento com uma mensagem real desse parceiro. Ative a troca do parceiro só depois que a prévia colocar cada campo no lugar certo, e verifique os primeiros documentos reais dele em Runs / Logs.