Ir para o conteúdo

FoccoSMF - Marketplaces

Utilização de Serviços de Envio e Consulta de Dados para Marketplace

Para utilização dos serviços do Marketplace é utilizado o padrão REST, utilizando JSON para envio e recebimento das informações.

A URL base para utilização dos serviços é o http://<IP>:<PORTA>/service/<SERVIÇO> do FoccoSMF.

Exemplo: http://172.16.11.109:8878/service/SendPricesMarketplace

1. Envio de Tarefas para o FoccoSMF

1.1 - JSON de envio de Tarefas

Atributo Informação
Chave de Acesso Chave do ambiente do cliente do FoccoERP.
Modelo Modelo de serviço do FoccoSMF, utilizar "MARKETPLACE".
CodigoGenerico Deve ser utilizado o nome do Marketplace que se deseja enviar/receber informações.
MarketplaceData Aqui devem ser enviados os dados que serão enviados ao Marketplace, sendo os dados de Autenticação, a URL base do Marketplace e os Dados (Produto, Preço, Estoque) conforme as estruturas definidas.
MarketplaceData.UrlBase URL base do Marketplace. Exemplo: https://cliente.souhibrido.com.br/
MarketplaceData.Authentication Dados de autenticação.
MarketplaceData.Data Dados do Marketplace conforme o serviço utilizado, por exemplo, se utilizado o serviço de envio de produto, deve ser enviada a estrutura do produto, caso utilizado o serviço de envio de preço, deve ser enviada a estrutura de preço.

Exemplo:

{
    "ChaveAmbiente": "FB9BD7CF-4DD7-4ECE-955B-464AE41D8988",
    "Modelo": "MARKETPLACE",
    "CodigoGenerico": "MAGENTO",
    "MarketplaceData": {
        "UrlBase": "https://cliente.souhibrido.com.br/",
        "Authentication": { },
        "Data": { }
    },
}

1.2 - JSON de envio para consulta de resultado de tarefas

URL: <URL base para utilização dos serviços>/service/GetTaskResult

Atributo Informação
ChaveAmbiente Chave do ambiente do cliente do FoccoERP.
Token Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa.

Exemplo

{
    "ChaveAmbiente": "FB9BD7CF-4DD7-4ECE-955B-464AE41D2004",
    "Token": "4041A17B-D946-4233-840A-6281DA13BF28"
}

1.3 - JSON de retorno do FoccoSMF

Essa estrutura de retorno é tanto para o agendamento de tarefas, quanto para a consulta de situação de tarefas.

Atributo Informação
Token Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa.
Status Status/situação da tarefa no FoccoSMF. Situações possíveis: Pendente, Sucesso e Falha.
Modelo Modelo de serviço do FoccoSMF, será o modelo utilizado no envio, no caso "MARKETPLACE".
Acao Identifica a ação/método executado pela tarefa, será o serviço utilizado. Exemplo:"SendPricesMarketplace"
Resultado Retorna o resultado da execução da tarefa.

Observação

Como os serviços do Marketplace são executados de maneira assíncrona com a chamada do serviço, o retorno do envio da tarefa sempre será "null". Na consulta de resultado da tarefa, quando a mesma for executada, será retornado o JSON de retorno, com o resultado do envio dos dados ao Marketplace.

Exemplo

{
    "Token": "F061789A-383A-45CA-9BB9-3425F26345BA",
    "Status": "Pendente",
    "Modelo": "MARKETPLACE",
    "Acao": "SendPricesMarketplace",
    "Resultado": null
}

2 - Envio de Produtos para Marketplaces via FoccoSMF

2.1. - Serviço de Envio de Produtos

URL: <URL base para utilização dos serviços>/SendProductsMarketplace JSON (Enviados em "Data" dos dados do Marketplace ("MarketplaceData" )

Atributo Tipo Informação Obrigatório
Products List\<object> Lista de produtos.
Products.Cnpj string CNPJ do estabelecimento.
Products.Sku string Código do Produto - Stock Keeping Unit (SKU). Limite de caracteres: 250. Sim
Products.Name string Descrição do item no Marketplace. Limite de caracteres: 250. S