Perguntas e Respostas (Q&A)
Recurso disponibilizado para interação via API entre clientes e sellers através de webhook
Perguntas e Respostas (Questions and Answers) é o recurso destinado à interação de sellers e clientes pré-venda. Através do endpoint disponibilizado (/qna
) é possível receber via API as perguntas realizadas pelo potencial cliente nos sites de venda e oferecer uma resposta capaz de auxiliá-lo antes da realização da compra.
POST - Solicitar credenciais
O recurso de Perguntas e Respostas utilizará a rota do rehub, sendo assim, o primeiro passo para a integração é a solicitação do token Bearer JWT através de um POST no seguinte endpoint:
Request headers:
Accept
application/json
Content-Type
application/json
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Request body:
Example request:
Response esperado:
200 - Success [OK]: Haverá um response body com o Bearer JWT:
POST - Cadastro do webhook
Para que seja possível receber notificações quando uma nova pergunta é realizada pelo cliente é necessário cadastrar a URL de um webhook para a transmissão de informações entre a API e a plataforma/ERP.
O cadastro será realizado a partir do POST no endpoint a seguir:
Request headers:
Accept
*/*
Content-Type
application/json
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Authorization
Request body:
Example request:
Response esperado:
204 - Success [No content]
As contas de teste não possuem vínculo com o marketplace e por este motivo o retorno pode ser de status 422 com a mensagem "An error ocurred while updating QnA data, please try again later".
Notificações
Após cadastro do webhook, a API da Americanas será capaz de encaminhar notificações para a plataforma/ERP através da URL registrada (cadastrada), cabendo ao sistema (plataforma/ERP) o consumo das informações direcionadas pela API para a referida URL.
Em caso de haverem novos questionamentos, a notificação contará com os seguintes dados:
Para respostas rejeitadas, as notificações seguirão o padrão disponibilizado a seguir:
Já as notificações de pergunta já respondida, terão o seguinte formato:
POST - Respondendo uma pergunta
O response mencionado acima trará informações sobre a estrutura da questão recebida. A partir dele será disponibilizado o ID da questão e este deverá ser utilizado para a interação do seller com o cliente.
A interação deverá ocorrer por intermédio de um POST no endpoint abaixo:
Request headers:
Accept
application/json
Content-Type
application/json
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Authorization
Request body:
Example request:
POST - Cancelando o cadastro
É possível desabilitar um parceiro para que não sejam mais recebidas notificações naquela conta.
Para realizar a inativação será necessário executar um POST no endpoint descrito abaixo:
Request headers:
Accept
*/*
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Authorization
Example request:
Response esperado:
204 - Success [No content]
As contas de teste não possuem vínculo com o marketplace e por este motivo o retorno pode ser de status 422 com a mensagem "An error ocurred while updating QnA data, please try again later".
Last updated