Webhooks
Webhooks permitem que você integre o Precifica | eCommerce à aplicações externas de forma simples e rápida.
Webhooks são URLs externas que recebem chamadas HTTP POST quando determinados eventos ocorrem na plataforma Precifica | eCommerce, e podem ser utilizados para alertas de preços ou precificação dinâmica.
Uma vez configurado, o webhook será acionado sempre que ocorrer um ou mais eventos subscritos.
Caso de Uso
o Precifica | eCommerce possibilita automatizar a precificação dos seus produtos com base em regras pré-estabelecidas. Estas regras são analisadas em tempo real sempre que há mudança no preço ou na disponibilidade de estoque da concorrência.
A automação da precificação depende da integração entre o Precifica | eCommerce e o sistema utilizado por você. Exemplos de sistemas utilizados são lojas virtuais (e-commerce) e sistemas de gestão ERP (Enterprise Resource Planning), dentre outros.
Payloads
Abaixo são descritos os detalhes técnicos para desenvolvimento da API a ser hospedada na loja virtual ou no ERP.
Para desenvolvimento da API, você deverá estar familiarizado com o método de requisição HTTP POST. Para mais informações leia o documento abaixo:
http://en.wikipedia.org/wiki/POST_(HTTP)
Os dados abaixo são enviados no padrão HTTP POST, codificados em JSON, pelo Precifica | eCommerce à API:
SKU
Especifica o SKU a ser atualizado. O SKU é obtido pelo Precifica | eCommerce durante o processo de monitoramento dos produtos na loja virtual.
| Parâmetro | Tipo | Obrigatório |
|---|---|---|
| sku | String(32) | Sim |
Exemplo: SKU980128
Preço Alvo
Especifica o novo preço para o SKU. O preço é formado com base nas regras pré-estabelecidas por você através da plataforma Precifica | eCommerce. Estas regras determinam quando o preço deve ser recalculado, como calcular o novo preço e qual o preço mínimo aceitável.
| Parâmetro | Tipo | Obrigatório |
|---|---|---|
| target_price | Double(0000.00) | Sim |
Exemplo: 1172.90
Domínio
Especifica o domínio do site onde o preço deve ser modificado.
| Parâmetro | Tipo | Obrigatório |
|---|---|---|
| domain | String(32) | Sim |
Exemplo: www.meudominio.com.br
Exemplo da requisição enviada para a API:
POST /example/api/service HTTP/1.1
Host: api.domain.tld
Authorization: Basic cHJlY2lmaWNhQHByZWNpZmljYTpwcmVjaWZpY2E=
User-Agent: Precifica/APIClient
Accept: application/json
Content-Length: 310
Content-Type: application/x-www-form-urlencoded
{
"change_description":"",
"sku":"SKU980128",
"change_id":"0",
"competitors":"1",
"target_price":"1172.90",
"domain":"www.domain.tld",
"current_value":"1151.88",
"title":"Glutamina+Black+Skull+300g+-+Sabor%3A+Sem+Sabor+-+Tamanho%3A+%C3%9Anico",
"previous_value":"1151.88"
}
O acesso à API deverá ser protegido por autenticação no padrão HTTP Basic Authentication. Para mais informações leia o documento abaixo:
http://en.wikipedia.org/wiki/Basic_access_authentication
Confirmação
Os dados abaixo deverão ser devolvidos em resposta à requisição acima:
Resultado
Especifica se a atualização do preço de venda foi processada com sucesso.
| Parâmetro | Tipo | Obrigatório |
|---|---|---|
| result | Bool(true/false) | Sim |
Exemplo: false
Mensagem adicional
Uma mensagem livre para detalhar um erro na atualização do preço de venda.
| Parâmetro | Tipo | Obrigatório |
|---|---|---|
| message | String(100) | Sim |
Exemplo: OK
Exemplo: 404: SKU not found
A API deverá responder utilizando o padrão JSON. Para mais informações leia o documento abaixo:
http://en.wikipedia.org/wiki/JSON
Exemplo da resposta da API:
HTTP/1.1 200 OK
Date: Wed, 01 Apr 2013 09:42:00 GMT
Content-Length: 2518
Connection: close
Content-Type: application/json
{
"result": true,
"message": "OK"
}