Documentação de Integração via Webservice por Json

(1)

Documentação de Integração via

Webservice por Json

(2)

Autenticação no Webservice

A autenticação deve ser sempre efetuada antes de realizar uma requisição seja ela de consulta,

inserção ou atualização.

Ela é feita através do método POST utilizando o link

http://painel.e-catalogos.net/api/json/auth/login

Parâmetros :

String: email

String: password

Caso seja autenticado com sucesso, será retornado um token onde o mesmo será utilizado em

todas as demais requisições efetuadas, mandando o mesmo pelo header da requisição.

Retorno em caso de sucesso:

{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGkvanNvbi9 hdXRoL2xvZ2luIiwiaWF0IjoxNDk5MzQ0OTk1LCJleHAiOjE0OTkzNDg1OTUsIm5iZiI6MTQ5OTM0NDk5NSwianRpIjoibXQy bHN6NHhmbjNNT2RaUCJ9.PBmAH0DrHZPsRH4qAku-YgN3d-wxkY95hjONGzEr_TM" }

Retorno em caso de falha:

{

"error": "Login ou senha inválidos" }

Em todo o restante da documentação esse token será tratado como TkGerado.

Detalhes para envio de todas as requisições

Após o login ser efetuado com sucesso e ser resgatado o token, ele terá que ser enviado em todas

as requisições pelo header (cabeçalho da requisição). Especificamente você informa o

token na

propriedade “

Authorization” do cabeçalho com o prefixo

Bearer +espaço+

TkGerado

.

Exemplo: Authorization: Bearer TkGerado

Nas requisições onde tenha que enviar informações por json, ou seja nos métodos (POST,PUT) o

Content-Type sempre terá que ser informado obrigatoriamente como abaixo.

Content-Type:

application/json

O json é enviado no body da requisição.

Inserir Representante

A inserção do Representante é realizada através do Método POST, pelo link

(3)

representantes.

Obs: Dados em vermelhos são obrigatórios

Exemplo:

{

"representante": [ {

"rp_nome": "Leandro Pereira Silva Bot", "rp_usuario": "RepresentanteTeste", "rp_senha": "123456", "rp_rg": "359978426", "rp_cpf": "45112323525", "rp_data_nascimento": "02031994", "rp_sexo": "m", "rp_data_emissao": "11022011", "rp_orgao_emissor": "SSP", "rp_orgao_uf_emissor": "SP", "rp_registro_core": "123456", "rp_email_1": "representanteo@gmail.com", "rp_email_2": null, "rp_email_3": null,

"rp_razao_social": "EXEMPLO REPRESENTAÇÕES 1 LTDA", "rp_nome_fantasia": "EXEMPLO REPRESENTAÇÕES 1", "rp_cnpj": "1569863496678",

"rp_inscricao_estadual": "7236273", "rp_inscricao_municipal": "673236", "rp_id_erp": 999,

"rp_cep": "06459874",

"rp_endereco": "Avenida Peixera do Corte", "rp_numero": 234,

"rp_complemento": "1 andar", "rp_bairro": "vale dos jasmins", "rp_cidade": "Amoreira", "rp_uf": "SP", "rp_lmt_desconto_especial": 2, "rp_acessou": null } ] }

Consultar Representante

A consulta do Representante é realizada através do Método GET, pelo link

http://painel.e-catalogos.net/api/json/v1/representante/

parametro

parâmetro

= Número do CPF do Representante (“Somente números”)

Retorno:

[ {

"rp_nome": "Leandro Pereira Silva Bot", "rp_rg": "359978426",

"rp_cpf": "45112323525",

(4)

"rp_sexo": "m", "rp_data_emissao": "11022011", "rp_orgao_emissor": "SSP", "rp_orgao_uf_emissor": "SP", "rp_registro_core": "123456", "rp_email_1": "teste@mail.com", "rp_email_2": null, "rp_email_3": null,

"rp_razao_social": "EXEMPLO REPRESENTAÇÕES 1 LTDA", "rp_nome_fantasia": "EXEMPLO REPRESENTAÇÕES 1", "rp_cnpj": "1569863496678",

"rp_inscricao_estadual": "7236273", "rp_inscricao_municipal": "673236", "rp_id_erp": 999,

"rp_cep": "06459874",

"rp_endereco": "Avenida Peixera do Corte", "rp_numero": 234,

"rp_complemento": "1 andar", "rp_bairro": "vale dos jasmins", "rp_cidade": "Amoreira", "rp_uf": "SP", "rp_lmt_desconto_especial": 2, "rp_acessou": null, } ]

Vincular Representante com Marca

Para vincular um Representante com uma marca é realizada através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/representante/marca

, poderá ser vinculados vários

representantes com as marcas.

Obs: Dados em vermelhos são obrigatórios, ambos devem estar cadastrados no sistema.

Exemplo:

{ "representante_marca": { "cpf_representante": "2111111000102",  "cnpj_marca": "29119665000147",  "cnpj_marca": "11111111000102", <!-- CNPJ da Marca →-> } }

Vincular Representante com Cliente

Para vincular um Representante com um cliente é realizado através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/representante/cliente

, poderá ser vinculados vários

representantes com os clientes.

(5)

Exemplo:

{ "representante_cliente": { "cpf_representante": "2111111000102",  "cnpj_cliente": "12111333000198",  "cnpj_cliente": "19119665000147", <!-- CNPJ do Cliente →-> } }

Inserir Cliente

A

inserção

do

Cliente

é

realizada

através

do

Método

POST,

pelo

link

http://painel.e-catalogos.net/api/json/v1/cliente

, poderá conter 1 ou mais clientes

Obs: Dados em vermelhos são obrigatórios

Exemplo:

{

"cliente": [ {

"cl_nome_comprador": "Anderson Neto", "cl_cargo": "Gerente",

"cl_razao": "Loja Casacos LTDA", "cl_fantasia": "Casacos e Cia", "cl_unidade": "SP", "cl_cnpj": "12111666000198", "cl_inscricao_estadual": "32123156465", "cl_telefone": "11945634569", "cl_email_cadastro": "rep@mail.net", "cl_email_1": "foo@mail.net.br", "cl_email_2": "", "cl_status": 0, "cl_codigo_erp": "999", "cl_exportado": 0, "unidade": {

"und_endereco": "Avenida Teste Unidade 1", "und_numero": 123,

"und_complemento": "3º andar", "und_bairro": "Jardim Unidade", "und_cidade": "UnidadeCity", "und_uf": "SP", "und_cep": "06558273", "und_telefone": "11978654231", "und_fax": "" }, "faturamento": { "fa_cep": "12345678",

"fa_endereco": "end. Faturamento", "fa_numero": 10,

"fa_complemento": "",

"fa_bairro": "bairro faturamento", "fa_cidade": "cidade faturamento", "fa_uf": "sp",

"fa_telefone": "1123456789", "fa_fax": ""

(6)

},

"transportadora": {

"tp_nome": "Nome Transportadora", "tp_email": "email@transportadora.com", "tp_telefone_1": "1123456789",

"tp_telefone_2": "" },

"socio": {

"sc_nome": "Sir Unidade", "sc_cpf": "45632178945", "sc_rg": "357896541", "sc_orgao_emissor": "SSP", "sc_data_expedicao": "2017-06-28 18:57:36", "sc_naturalidade": "barueri", "sc_nacionalidade": "brasileiro", "sc_email": "foo@mail.net" }, "referencia_bancaria": { "rb_banco": "234", "rb_agencia": "1559-87", "rb_conta": "23456", "rb_gerente": "Gerson", "rb_email_gerente": "gerente@mail.com", "rb_telefone_gerente": "11987564231" }, "referencia_comercial": {

"rc_fornecedor": "Comercial Referencia teste", "rc_telefone": "11987656789",

"rc_responsavel": "Responsavel teste", "rc_email": "rc@mail.net" }, "credito": { "crd_total": "100000", "crd_utilizado": "0", "crd_valor_minimo": "200" } } ] }

Consultar Cliente

Existem duas formas para consulta de clientes :

A primeira forma consulta apenas um cliente que é realizada através do Método GET, pelo link

http://painel.e-catalogos.net/api/json/v1/cliente/

parametro

parâmetro

= Número do CNPJ do cliente (Somente Números)

A segunda forma é para consultar todos os clientes que ainda não foram exportados, e ela é

realizada através do Método GET, pelo link

http://painel.e-catalogos.net/api/xml/v1/cliente

Obs: Ambas retornam os mesmos dados do cliente, porém a segunda forma pode retornar um ou

mais dados.

(7)

[ {

"cl_nome_comprador": "Anderson Neto", "cl_cargo": "Gerente",

"cl_razao": "Loja Casacos LTDA", "cl_fantasia": "Casacos e Cia", "cl_unidade": "SP", "cl_cnpj": "12111666000198", "cl_inscricao_estadual": "32123156465", "cl_telefone": "11945634569", "cl_email_cadastro": "rep@mail.net", "cl_email_1": "foo@mail.net.br", "cl_email_2": "", "cl_status": 0, "cl_codigo_erp": "999", "cl_exportado": 0, "unidade": {

"und_endereco": "Avenida Teste Unidade 1", "und_numero": 123,

"und_complemento": "3º andar", "und_bairro": "Jardim Unidade", "und_cidade": "UnidadeCity", "und_uf": "SP", "und_cep": "06558273", "und_telefone": "11978654231", "und_fax": "", }, "faturamento": { "fa_cep": "12345678",

"fa_endereco": "end. Faturamento", "fa_numero": 10,

"fa_complemento": "",

"fa_bairro": "bairro faturamento", "fa_cidade": "cidade faturamento", "fa_uf": "sp",

"fa_telefone": "1123456789", "fa_fax": "",

},

"transportadora": {

"tp_nome": "Nome Transportadora", "tp_email": "email@transportadora.com", "tp_telefone_1": "1123456789",

"tp_telefone_2": "", },

"socio": {

"sc_nome": "Sir Unidade", "sc_cpf": "45632178945", "sc_rg": "357896541", "sc_orgao_emissor": "SSP", "sc_data_expedicao": "2017-06-28 18:57:36", "sc_naturalidade": "barueri", "sc_nacionalidade": "brasileiro", "sc_email": "foo@mail.net", }, "referencia_bancaria": { "rb_banco": "234", "rb_agencia": "1559-87", "rb_conta": "23456", "rb_gerente": "Gerson", "rb_email_gerente": "gerente@mail.com",

(8)

"rb_telefone_gerente": "11987564231", },

"referencia_comercial": {

"rc_fornecedor": "Comercial Referencia teste", "rc_telefone": "11987656789",

"rc_responsavel": "Responsavel teste", "rc_email": "rc@mail.net", }, "credito": { "crd_total": "100000", "crd_utilizado": "0", "crd_valor_minimo": "200", } } ]

Atualizar Cliente p/ Exportado

Para atualizar um ou mais clientes como exportados é realizado através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/cliente/updateJson

, poderá ser atualizados vários

clientes na mesma requisição.

Obs: Dados em vermelhos são obrigatórios.

Exemplo:

{ "cliente": { "cl_cnpj": "11111111000102",<!-- CNPJ do Cliente →-> }, "cliente": { "cl_cnpj": "21111111000102",<!-- CNPJ do Cliente →-> } }

Vincular Cliente com Marca

Para vincular um Cliente com uma marca é realizado através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/cliente/marca

, poderá ser vinculado vários clientes com

as marcas.

Obs: Dados em vermelhos são obrigatórios, ambos devem estar cadastrados no sistema.

Exemplo:

{ "cliente_marca": { "cnpj_cliente": "12111333000198",  "cnpj_marca": "12111333000198",  "cnpj_marca": "19119665000147", <!-- CNPJ da Marca →-> } }

(9)

Inserir Produto

A inserção do Produto é realizada através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/produto

,poderá conter 1 ou mais produtos.

Obs: Dados em vermelhos são obrigatórios, a marca já deve estar inserida no sistema

obrigatoriamente, a categoria caso não exista será criada, um produto pode ter várias informações

adicionais

.

Exemplo:

{

"produto": {

"prd_marca": "MARCA EXEMPLO",  "prd_categoria": "BRINQUEDO",  "prd_referencia": "37",

"prd_nome": "BIQUINI",

"prd_info_descricao": "Descrição", "prd_colecao": "BIQUINI COLECAO",

"prd_info_tecnicas": "descrições técnicas do produto",

"prd_info_composicao": "informar aqui composição do material", "prd_data_inicio": "2017-06-12 18:20:43", "prd_data_fim": "2017-07-12 18:20:43", "prd_prazo_entrega": "2017-06-12 18:20:43", "prd_controle_estoque": "0", "prd_desconto_unitario": "0.0", "prd_codigo_barras": "1234",

"prd_oferta": "1",  "prd_grade": "1",  "prd_ipi": "123",  "categoria": { "cat_nome": "BIQUINI", "cat_id_erp": "999", "cat_id_erp_colecao": "9999", "cat_visivel": "1", "cat_excluido": "0", },  "marca": {

"mc_nome": "MARCA EXEMPLO", "mc_visualizar": "1",

"mc_cnpj": "19119665000147", "mc_endereco": "Avenida dos anjos", "mc_numero": "44",

"mc_complemento": "", "mc_bairro": "Jardim Europa", "mc_cidade": "São paulo", "mc_uf": "SP", "mc_cep": "064781489", "mc_id_erp": "999", "mc_visualizar": "1", "mc_excluido": "0", },

 produto_informacao: {

"ifp_codigo": "10.22", "ifp_valor": "10.22",

(10)

"ifp_estoque_erp": "1000", "ifp_estoque_interno": "1000", "ifp_quantidade_minima": "10", "ifp_quantidade_multipla": "2", "ifp_peso": "2.1", "ifp_altura": "2.75", "ifp_largura": "2.0", "ifp_profundidade": "0.05", "ifp_sku_erp": "231564479",

"ifp_destaque": "0",  "ifp_tamanho": "GG", "ifp_cor": "Vermelho", } } }

Consultar Produto

Existem duas formas para consulta de produtos :

A primeira forma consulta apenas um produto que é realizada através do Método GET, pelo link

http://painel.e-catalogos.net/api/json/v1/produto/

parametro

parâmetro

= Referência do produto

A segunda forma é para consultar todos os produtos que ainda não foram exportados, e ela é

realizada através do Método GET, pelo link

http://painel.e-catalogos.net/api/json/v1/produto

Obs: Ambas retornam os mesmos dados do produto, porém a segunda forma pode retornar um

ou mais dados. Um produto pode ter várias informações adicionais

.

Retorno:

{

"produto": {

"prd_nome": "BIQUINI", "prd_referencia": "MTTH9",

"prd_colecao": "BIQUINI COLECAO",

"prd_info_tecnicas": "descrições técnicas do produto",

"prd_info_composicao": "informar aqui composição do material", "prd_data_inicio": "2017-06-12", "prd_data_fim": "2017-07-12", "prd_prazo_entrega": "2017-06-12", "prd_desconto_unitario": "0.0", "prd_codigo_barras": "1234", "prd_oferta": "0", "prd_visualizar": "1", "prd_excluido": "0", "prd_exportado": "0",  "categoria": { "cat_nome": "BIQUINI", "cat_id_erp": "999",

(11)

"cat_id_erp_colecao": "9999", "cat_visivel": "1", "cat_excluido": "0", },  marca: {

"mc_nome": "MARCA EXEMPLO", "mc_visualizar": "1",

"mc_cnpj": "19119665000147", "mc_endereco": "Avenida dos anjos", "mc_numero": "44",

"mc_complemento": "", "mc_bairro": "Jardim Europa", "mc_cidade": "São paulo", "mc_uf": "SP", "mc_cep": "064781489", "mc_id_erp": "999", "mc_visualizar": "1", "mc_excluido": "0", },

 "produto_informacao": { "ifp_valor": "10.22", "ifp_estoque_erp": "1000", "ifp_estoque_interno": "1000", "ifp_quantidade_minima": "10", "ifp_quantidade_multipla": "2", "ifp_peso": "2.1", "ifp_altura": "2.75", "ifp_largura": "2.0", "ifp_profundidade": "0.05", "ifp_sku_erp": "231564479", "ifp_destaque": "0", "ifp_excluido": "0", "tamanho": { "tmh_nome": "P", "tmh_id_erp": "999", "tmh_excluido": "0", "tmh_visualizar": "1", }, "cor": { "cor_nome": "Vermelho", "cor_visualizar": "1", "cor_excluido": "0", "cor_id_erp": "999", }, } } }

(12)

Atualizar Produto

A atualização do Produto é realizada através do Método POST, pelo link

http://loja.e-catalogos.net/api/json/v1/produto/update

,poderá conter 1 ou mais produtos.

Obs: Dados em vermelhos são obrigatórios, produto_informacao não é obrigatório pode ser

desconsiderado porém antes do último objeto retirar a virgula.

Exemplo:

{

"produto": [ {

"prd_referencia": "AA37", "prd_nome": "Biquini Azul",

"prd_info_descricao": "Descrição da referência", "prd_colecao": "VERÃO 2018",

"prd_info_tecnicas": "descricoes tecnicas deste produto", "prd_info_composicao": "informacoes de composicao", "prd_data_inicio": "2017-06-12", "prd_data_fim": "2017-07-12", "prd_prazo_entrega": "2017-06-12", "prd_controle_estoque": "0", "prd_desconto_unitario": "0.0", "prd_codigo_barras": "123412340987", "prd_oferta": "0", "prd_grade": "0", "prd_ipi": "0", "produto_informacao" : [ { "ifp_codigo": "10.22", "ifp_valor": "10.22", "ifp_estoque_erp": "1000", "ifp_estoque_interno": "1000", "ifp_quantidade_minima": "10", "ifp_quantidade_multipla": "2", "ifp_peso": "2.1", "ifp_altura": "2.75", "ifp_largura": "2.0", "ifp_profundidade": "0.05", "ifp_sku_erp": "231564479", "ifp_destaque": "0", "ifp_tamanho": "GG", "ifp_cor": "Vermelho" } ] } ] }

Atualizar produto p/ Exportado

Para atualizar um ou mais produto como exportado é realizado através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/produto/updateJson

, poderá ser atualizados vários

produtos.

(13)

Obs: Dados em vermelhos são obrigatórios.

Exemplo:

{

produto: {

"prd_referencia": "MTTH9",  },

produto: {

"prd_referencia": "MTTH10",  }

}

Consultar Pedido

Existem duas formas para consulta os pedidos :

A primeira forma consulta apenas um pedido que é realizada através do Método GET, pelo link

http://painel.e-catalogos.net/api/json/v1/produto/

parametro

parâmetro

= Número do pedido

A segunda forma é para consultar todos os produtos que ainda não foram exportados, e ela é

realizada através do Método GET, pelo link

http://painel.e-catalogos.net/api/json/v1/produto

Ambas retornam os mesmos dados do pedido, porém a segunda forma pode retornar um ou mais

dados.

Exemplo:

{ "pedido": { "ped_data_pagamento": "2017-06-21", "ped_data_entrega": "2017-06-21", "ped_modo_entrega": "2017-06-21", "ped_data_pedido": "2017-06-21", "ped_numero_pedido": "1234567790",

"ped_observacao": "faturar ao lado do vendedor", "ped_exportado": "0",

"cliente": {

"cl_nome_comprador": "Anderson Neto", "cl_razao": "Loja Casacos LTDA",

"cl_fantasia": "Casacos e Cia", "cl_cnpj": "12111666000198", "cl_telefone": "11945634569", "cl_email_cadastro": "rep@mail.net", },  "carrinho_pedido": { "crp_session": "123456789987654321", "crp_ipi": "0", "crp_icms": "0", "crp_data": "2017-06-21", "crp_quantidade": "10", "crp_preco_unitario": "12.0", "crp_desconto_parcela": "0.0", "crp_desconto_especial": "2.0",

(14)

"crp_forma_pagamento": "12", "crp_desconto_volume": "0", "crp_desconto_unitario": "0.0", "crp_quantidade_multipla": "1", "crp_tamanho": "P", "crp_cor": "Vermelho", }, "carrinho_pedido": { "crp_session": "123456789987654322", "crp_ipi": "0", "crp_icms": "0", "crp_data": "2017-06-21", "crp_quantidade": "10", "crp_preco_unitario": "12.0", "crp_desconto_parcela": "0.0", "crp_desconto_especial": "2.0", "crp_forma_pagamento": "12", "crp_desconto_volume": "0", "crp_desconto_unitario": "0.0", "crp_quantidade_multipla": "1", "crp_tamanho": "G", "crp_cor": "Verde", }, } }

Atualizar pedido p/ Exportado

Para atualizar um ou mais pedido como exportado é realizado através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/pedido/updateJson

, poderá ser atualizados vários

produtos.

Obs: Dados em vermelhos são obrigatórios.

Exemplo:

{

"pedido": {

"ped_numero_pedido": "MTTH9",  },

"pedido": {

"ped_numero_pedido": "MTTH10",  }

}

Inserir Categoria

A inserção da categoria é realizada através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/c

ategoria , poderá conter 1 ou mais categorias

Obs: Dados em vermelhos são obrigatórios*

(15)

Exemplo:

{ "categoria": [ { "cat_nome": "BIQUINI", "cat_id_erp": "999", "cat_id_erp_colecao": 9999 }, { "cat_nome": "BRINQUEDO", "cat_id_erp": "999", "cat_id_erp_colecao": 9999 } ] }

Inserir Marca

A inserção da marca é realizada através do Método POST, pelo link

http://painel.e-catalogos.net/api/json/v1/marca

, poderá conter 1 ou mais marcas.

Obs: Dados em vermelhos são obrigatórios

Exemplo:

{

"marca": [ {

"mc_nome": "MARCA EXEMPLO 3", "mc_cnpj": "19119665000143", "mc_endereco": "Avenida dos anjos", "mc_numero": 43,

"mc_complemento": "",

"mc_bairro": "jardim dos rosários", "mc_cidade": "são paulo",

"mc_uf": "SP",

"mc_cep": "64781489", "mc_id_erp": "999" },

{

"mc_nome": "MARCA EXEMPLO 4", "mc_cnpj": "19229335000614", "mc_endereco": "Avenida dos anjos", "mc_numero": 43,

"mc_complemento": "",

"mc_bairro": "jardim dos rosários", "mc_cidade": "são paulo",

"mc_uf": "SP", "mc_cep": "64781489", "mc_id_erp": "999" } ] }

Documentação de Integração via Webservice por Json