Perguntas Frequentes

Esta seção traz as perguntas mais frequentes recebidas pelo time de suporte a API

Processo de Homologação

Como é o processo de homologação?

Após solicitar a homologação de seu sistema, serão liberadas pelo time de suporte a integração as credenciais para uma conta de teste e a lista de tarefas (cheklist) que devem ser executadas para a validação dos processos desenvolvidos.

Uma vez que as tarefas forem executadas, as evidências para validação devem ser encaminhadas através de um chamado para o [e-mail].

O time de API irá validar a estrutura das requisições recebidas e qualquer ponto em não conformidade será sinalizado para a correção. Após todos os pontos serem validados e apresentarem as estruturas necessárias para atuação com a API da Americanas, o sistema desenvolvido será liberado para utilização em ambiente de produção.

O que é e como obtenho o header x-accountmanager-key?

O header x-accountmanager-key é o código identificador de seu sistema, ou seja, ele é o código que permite-nos validar qual plataforma está executando requisições para a API da Americanas.

Esse identificador é fornecido exclusivamente para parceiros que solicitam o processo de homologação e deve ser utilizado em todas as requisições via API.

Quais são os passos para a homologação?

O processo de homologação com a API da Americanas é simples e consiste na validação das requisições e estrutura dos dados enviados nas tarefas solicitadas em nosso checklist, encaminhado junto às credenciais da conta de teste (para maiores informações, acesse a guia Processo de Homologação desta documentação).

De forma mais detalhada, os passos para a homologação de seu sistema consistem em:

1. Definição do perfil para homologação: É importante compreender qual o perfil do sistema a ser homologado (os perfis podem ser consultados em nossa guia Perfil para Homologação);

2. Criação da conta de teste: Após receber o seu acionamento para início do processo de homologação, nossos times irão criar um ambiente de desenvolvimento para a plataforma/ERP. As credenciais para acesso a conta de teste serão informadas via chamado junto às tarefas que deverão ser executadas;

3. Execução de testes e preenchimento do checklist: Em posse das credenciais da conta de teste, o responsável pelo sistema deverá validar o nosso checklist, que nada mais é do que a lista de tarefas que precisam ser concluídas para que possamos validar o envio de informações para a API;

4. Validação do desenvolvimento: Após a execução e envio das tarefas solicitadas, o time de API da Americanas irá validar as requisições encaminhadas pelo seu sistema.

Preciso solicitar uma conta de teste para cada recurso que será homologado?

Não é necessário solicitar uma conta de teste para cada recurso a ser homologado.

Ao solicitar a homologação de seu sistema será preciso que realize o processo obrigatório, que visa o desenvolvimento e a validação dos recursos básicos da API (produtos, conexão via rehub, pedidos e etiquetas).

No final da homologação básica, a conta de teste fornecida será mantida ativa para que, caso deseje, realize o desenvolvimento e validação (homologação) dos demais recursos disponibilizados pela API.

Um ponto importante é que ao desenvolver um novo recurso é imprescindível que entre em contato com o time de API da Americanas para que a homologação seja validada. Este contato se dá através do e-mail [e-mail].

Produtos

Status 401 ou 403 - não autenticado/não autorizado - na criação/atualização de produtos

Um cenário que pode gerar impacto negativo para a integração ocorre quando o seller realiza a inativação de usuários no front da API, porém não atualiza esta informação na plataforma/ERP. Em casos como este é comum as tentativas de envio de requisições para a API – notadas principalmente nos endpoints relacionados aos produtos – retornarem status 401 (não autenticado) ou 403 (não autorizado).

Para correção, é necessário entrar em contato com o seller para validação das credenciais da conta na API, principalmente os e-mails ativos.

Caso as credenciais tenham sido validadas e ainda constem divergências, o time de API deverá ser acionado através de chamado para o e-mail [e-mail].

Rehub

Será retornado algum erro ao tentar excluir um produto ainda conectado ao marketplace?

Sim, por padrão a API retorna erros para a exclusão de itens que ainda estão conectados ao marketplace Americanas.

Caso haja uma tentativa de excluir um produto ainda conectado será retornado o status 422 e a mensagem "Produto está conectado. Remova todas as conexões e tente novamente".

Pedidos

Status 403 ao tentar criar um pedido

Como citado em nossa seção de dúvidas sobre o recurso de Produtos, o status 403 é retornado em ações não autorizadas.

Em relação a criação de pedidos, o status 403 é comumente visto em casos em que o parceiro realiza tentativas de criar um pedido em uma conta de produção.

Na seção de Criação e Aprovação de Pedido Teste mencionamos que tanto criação quanto aprovação de pedidos são ações exclusivas para as contas de teste, sendo assim, uma conta de produção não permitirá tais tratativas.

Etiquetas

Serão emitidas etiquetas para os pedidos gerados em minha conta de teste?

Para o ambiente de teste as etiquetas são disponibilizadas previamente com dados fixos, desta forma, os pedidos criados em uma conta de teste não possuirão etiquetas com seus dados.

Para realizar todo o fluxo de etiquetas em uma conta de teste - desde a criação do produto até a impressão da etiqueta e solicitação da coleta do pedido - é possível seguir as orientações fornecidas em nosso guia Etiquetas na conta de teste da seção Integração Etiqueta, onde disponibilizamos os passos para realizar o vínculo de um pedido criado em ambiente de teste com uma etiqueta previamente gerada.

Fulfillment

É possível consumir os pedidos Fulfillment separadamente?

Todos os pedidos gerados no marketplace e disponibilizados pela API serão consumidos sem distinção através da /queues/orders, isto é, uma vez que o parceiro (seller) possui o serviço Fulfillment, todos os pedidos desta modalidade serão disponibilizados junto às demais entregas criadas para a loja.

Desta forma, cabe à plataforma/ERP a identificação do tipo do pedido. Caso hajam dúvidas, é possível consultar a guia Identificando Pedido de nossa seção Fulfillment.