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

Transcrição

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 Parâmetros : String: 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. 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 poderá conter 1 ou mais

3 representantes. Obs: Dados em vermelhos são obrigatórios "representante": [ " rp_nome ": " Leandro Pereira Silva Bot ", " rp_usuario ": " RepresentanteTeste ", " rp_senha ": " ", "rp_rg": " ", "rp_cpf": " ", "rp_data_nascimento": " ", "rp_sexo": "m", "rp_data_emissao": " ", "rp_orgao_emissor": "SSP", "rp_orgao_uf_emissor": "SP", "rp_registro_core": "123456", " rp_ _1 ": " representanteo@gmail.com ", "rp_ _2": null, "rp_ _3": null, " rp_razao_social ": " EXEMPLO REPRESENTAÇÕES 1 LTDA ", "rp_nome_fantasia": "EXEMPLO REPRESENTAÇÕES 1", " rp_cnpj ": " ", "rp_inscricao_estadual": " ", "rp_inscricao_municipal": "673236", "rp_id_erp": 999, "rp_cep": " ", "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 parametro parâmetro = Número do CPF do Representante ( Somente números ) Retorno: [ "rp_nome": "Leandro Pereira Silva Bot", "rp_rg": " ", "rp_cpf": " ", "rp_data_nascimento": " ",

4 ] "rp_sexo": "m", "rp_data_emissao": " ", "rp_orgao_emissor": "SSP", "rp_orgao_uf_emissor": "SP", "rp_registro_core": "123456", "rp_ _1": "rp_ _2": null, "rp_ _3": null, "rp_razao_social": "EXEMPLO REPRESENTAÇÕES 1 LTDA", "rp_nome_fantasia": "EXEMPLO REPRESENTAÇÕES 1", "rp_cnpj": " ", "rp_inscricao_estadual": " ", "rp_inscricao_municipal": "673236", "rp_id_erp": 999, "rp_cep": " ", "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 poderá ser vinculados vários representantes com as marcas. Obs: Dados em vermelhos são obrigatórios, ambos devem estar cadastrados no sistema. "representante_marca": " cpf_representante ": " ", <!-- CPF do representante --> " cnpj_marca ": " ", <!-- CNPJ da Marca ->, "representante_marca": " cpf_representante ": " ", <!-- CPF do representante --> " cnpj_marca ": " ", <!-- CNPJ da Marca -> Vincular Representante com Cliente Para vincular um Representante com um cliente é realizado através do Método POST, pelo link poderá ser vinculados vários representantes com os clientes. Obs: Dados em vermelhos são obrigatórios, ambos devem estar cadastrados no sistema.

5 "representante_cliente": " cpf_representante ": " ", <!-- CPF do representante --> " cnpj_cliente ": " ", <!-- CNPJ do Cliente ->, "representante_cliente": " cpf_representante ": " ", <!-- CPF do representante --> " cnpj_cliente ": " ", <!-- CNPJ do Cliente -> Inserir Cliente A inserção do Cliente é realizada através do Método POST, pelo link poderá conter 1 ou mais clientes Obs: Dados em vermelhos são obrigatórios "cliente": [ " cl_nome_comprador ": " Anderson Neto ", "cl_cargo": "Gerente", " cl_razao ": " Loja Casacos LTDA ", "cl_fantasia": "Casacos e Cia", "cl_unidade": "SP", " cl_cnpj ": " ", "cl_inscricao_estadual": " ", "cl_telefone": " ", "cl_ _cadastro": "rep@mail.net", "cl_ _1": "foo@mail.net.br", "cl_ _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": " ", "und_telefone": " ", "und_fax": "", "faturamento": "fa_cep": " ", "fa_endereco": "end. Faturamento", "fa_numero": 10, "fa_complemento": "", "fa_bairro": "bairro faturamento", "fa_cidade": "cidade faturamento", "fa_uf": "sp", "fa_telefone": " ", "fa_fax": ""

6 ], "transportadora": "tp_nome": "Nome Transportadora", "tp_ ": "tp_telefone_1": " ", "tp_telefone_2": "", "socio": "sc_nome": "Sir Unidade", "sc_cpf": " ", "sc_rg": " ", "sc_orgao_emissor": "SSP", "sc_data_expedicao": " :57:36", "sc_naturalidade": "barueri", "sc_nacionalidade": "brasileiro", "sc_ ": "referencia_bancaria": "rb_banco": "234", "rb_agencia": " ", "rb_conta": "23456", "rb_gerente": "Gerson", "rb_ _gerente": "rb_telefone_gerente": " ", "referencia_comercial": "rc_fornecedor": "Comercial Referencia teste", "rc_telefone": " ", "rc_responsavel": "Responsavel teste", "rc_ ": "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 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 Obs: Ambas retornam os mesmos dados do cliente, porém a segunda forma pode retornar um ou mais dados. Retorno:

7 [ "cl_nome_comprador": "Anderson Neto", "cl_cargo": "Gerente", "cl_razao": "Loja Casacos LTDA", "cl_fantasia": "Casacos e Cia", "cl_unidade": "SP", "cl_cnpj": " ", "cl_inscricao_estadual": " ", "cl_telefone": " ", "cl_ _cadastro": "rep@mail.net", "cl_ _1": "foo@mail.net.br", "cl_ _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": " ", "und_telefone": " ", "und_fax": "",, "faturamento": "fa_cep": " ", "fa_endereco": "end. Faturamento", "fa_numero": 10, "fa_complemento": "", "fa_bairro": "bairro faturamento", "fa_cidade": "cidade faturamento", "fa_uf": "sp", "fa_telefone": " ", "fa_fax": "",, "transportadora": "tp_nome": "Nome Transportadora", "tp_ ": " @transportadora.com", "tp_telefone_1": " ", "tp_telefone_2": "",, "socio": "sc_nome": "Sir Unidade", "sc_cpf": " ", "sc_rg": " ", "sc_orgao_emissor": "SSP", "sc_data_expedicao": " :57:36", "sc_naturalidade": "barueri", "sc_nacionalidade": "brasileiro", "sc_ ": "foo@mail.net",, "referencia_bancaria": "rb_banco": "234", "rb_agencia": " ", "rb_conta": "23456", "rb_gerente": "Gerson", "rb_ _gerente": "gerente@mail.com",

8 ] "rb_telefone_gerente": " ",, "referencia_comercial": "rc_fornecedor": "Comercial Referencia teste", "rc_telefone": " ", "rc_responsavel": "Responsavel teste", "rc_ ": "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 poderá ser atualizados vários clientes na mesma requisição. Obs: Dados em vermelhos são obrigatórios. "cliente": " cl_cnpj ": " ",<!-- CNPJ do Cliente ->, "cliente": " cl_cnpj ": " ",<!-- CNPJ do Cliente -> Vincular Cliente com Marca Para vincular um Cliente com uma marca é realizado através do Método POST, pelo link poderá ser vinculado vários clientes com as marcas. Obs: Dados em vermelhos são obrigatórios, ambos devem estar cadastrados no sistema. "cliente_marca": " cnpj_cliente ": " ", <!-- CNPJ do cliente --> " cnpj_marca ": " ", <!-- CNPJ da Marca ->, "cliente_marca": " cnpj_cliente ": " ", <!-- CNPJ do cliente --> " cnpj_marca ": " ", <!-- CNPJ da Marca ->

9 Inserir Produto A inserção do Produto é realizada através do Método POST, pelo link 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. "produto": " prd_marca ": " MARCA EXEMPLO ", <!-- Nome da Marca no Sistema --> " prd_categoria ": " BRINQUEDO ", <!-- Nome da Categoria no Sistema --> " 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 ": " :20:43 ", " prd_data_fim ": " :20:43 ", " prd_prazo_entrega ": " :20:43 ", "prd_controle_estoque": "0", "prd_desconto_unitario": "0.0", "prd_codigo_barras": "1234", " prd_oferta ": " 1 ", <!-- 0 para não, 1 para sim --> "prd_grade": "1", <!-- 0 para não, 1 para sim --> "prd_ipi": "123", <!-- Categoria do Produto --> "categoria": "cat_nome": "BIQUINI", "cat_id_erp": "999", "cat_id_erp_colecao": "9999", "cat_visivel": "1", "cat_excluido": "0",, <!-- Marca do Produto --> "marca": "mc_nome": "MARCA EXEMPLO", "mc_visualizar": "1", "mc_cnpj": " ", "mc_endereco": "Avenida dos anjos", "mc_numero": "44", "mc_complemento": "", "mc_bairro": "Jardim Europa", "mc_cidade": "São paulo", "mc_uf": "SP", "mc_cep": " ", "mc_id_erp": "999", "mc_visualizar": "1", "mc_excluido": "0",, <!-- Informações Adicionais do Produto --> 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": " ", "ifp_destaque": "0", <!-- 0 para não, 1 para sim --> "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 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 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": " ", "prd_data_fim": " ", "prd_prazo_entrega": " ", "prd_desconto_unitario": "0.0", "prd_codigo_barras": "1234", "prd_oferta": "0", "prd_visualizar": "1", "prd_excluido": "0", "prd_exportado": "0", <!-- Categoria do Produto --> "categoria": "cat_nome": "BIQUINI", "cat_id_erp": "999",

11 "cat_id_erp_colecao": "9999", "cat_visivel": "1", "cat_excluido": "0",, <!-- Marca do Produto --> marca: "mc_nome": "MARCA EXEMPLO", "mc_visualizar": "1", "mc_cnpj": " ", "mc_endereco": "Avenida dos anjos", "mc_numero": "44", "mc_complemento": "", "mc_bairro": "Jardim Europa", "mc_cidade": "São paulo", "mc_uf": "SP", "mc_cep": " ", "mc_id_erp": "999", "mc_visualizar": "1", "mc_excluido": "0",, <!-- Informações Adicionais do Produto --> "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": " ", "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 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. "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": " ", "prd_data_fim": " ", "prd_prazo_entrega": " ", "prd_controle_estoque": "0", "prd_desconto_unitario": "0.0", "prd_codigo_barras": " ", "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": " ", "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 poderá ser atualizados vários produtos.

13 Obs: Dados em vermelhos são obrigatórios. produto: " prd_referencia ": " MTTH9 ", <!--Referência do produto -->, produto: " prd_referencia ": " MTTH10 ", <!--Referência do produto --> Existem duas formas para consulta os pedidos : Consultar Pedido A primeira forma consulta apenas um pedido que é realizada através do Método GET, pelo link 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 Ambas retornam os mesmos dados do pedido, porém a segunda forma pode retornar um ou mais dados. "pedido": "ped_data_pagamento": " ", "ped_data_entrega": " ", "ped_modo_entrega": " ", "ped_data_pedido": " ", "ped_numero_pedido": " ", "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": " ", "cl_telefone": " ", "cl_ _cadastro": "rep@mail.net",, <!-- Itens do pedido --> "carrinho_pedido": "crp_session": " ", "crp_ipi": "0", "crp_icms": "0", "crp_data": " ", "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": " ", "crp_ipi": "0", "crp_icms": "0", "crp_data": " ", "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 poderá ser atualizados vários produtos. Obs: Dados em vermelhos são obrigatórios. "pedido": " ped_numero_pedido ": " MTTH9 ", <!-- Número do pedido -->, "pedido": " ped_numero_pedido ": " MTTH10 ", <!-- Número do pedido --> Inserir Categoria A inserção da categoria é realizada através do Método POST, pelo link ategoria, poderá conter 1 ou mais categorias Obs: Dados em vermelhos são obrigatórios*

15 "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 poderá conter 1 ou mais marcas. Obs: Dados em vermelhos são obrigatórios "marca": [ " mc_nome ": " MARCA EXEMPLO 3 ", " mc_cnpj ": " ", "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": " ", "mc_id_erp": "999", " mc_nome ": " MARCA EXEMPLO 4 ", " mc_cnpj ": " ", "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": " ", "mc_id_erp": "999" ]