Integração via Web Service de Clientes - Logix

Linha de Produto:

Logix.

Segmento:

Manufatura.

Módulo:

Vendas e Distribuição.

Função:

VDPR0007 - VDP90430 - VDP90076.

Situação/Requisito:

Permitir que seja realizado no Logix o cadastro de clientes via rotinas externas.

Solução/Implementação:

Desenvolvido rotinas Web Service (API REST) para que seja possível realizar a inclusão de um cliente por rotinas externas ao Logix de acordo com regras e padrões Totvs.

Detalhamento:

Contexto de negócio

Com o desenvolvimento de Web Service para cadastro de Clientes do Logix, é possível a utilização dessas funcionalidades/serviços em uma variada gama de aplicações, como por exemplo páginas WEB, aplicativos mobile, Fluig e outros sistemas que suportam requisições HTTP com protocolo REST.

Sistemas Envolvidos

ERP Logix - Cadastro de clientes.

Escopo

Desenvolvido Web Services (WS) no sistema REST para a funcionalidade de inclusão de clientes.

Para mais informações sobre o sistema REST na TOTVS, consulte o link: *REST ADVPL.*

Pré-requisitos instalação/implantação/utilização

Logix versão 12 com pacote mínimo 12.1.21.
Server TOTVS TEC configurado com serviço REST. Para mais informações verifique: *01. Configuração.*
Liberar no Firewall a porta configurada no server TOTVS TEC para o serviço REST.

Web Services

1 - Inclusão de Cliente

Objetivo: Incluir cadastro de um cliente.

Operação: POST

Exemplo da URL: http://SERVER:PORT/logixrest/vdpr0007/incluiCliente

Parâmetros de entrada (Tipo: PayLoad):

Dados mestre

Chave	Parâmetro	Definição	Observação
lr_principal	empresa	empresa.cod_empresa	Obrigatório
lr_principal	usuario	usuarios.cod_usuario	Obrigatório
lr_mestre	codigo	clientes.cod_cliente	Se não for informado, será o CNPJ/CPF sem formatação
lr_mestre	nome	vdp_cli_fornec_cpl.razao_social	Obrigatório
lr_mestre	nome_reduzido	vdp_cli_fornec_cpl.razao_social_reduz	Aceita branco
lr_mestre	nome_contato	clientes.nom_contato	Aceita branco
lr_mestre	situacao	clientes.ies_situacao	Obrigatório
lr_mestre	tipo_cliente	clientes.cod_tip_cli	Obrigatório
lr_mestre	frete_posto	clientes.den_frete_posto	Aceita branco
lr_mestre	classe	clientes.cod_class	Aceita branco
lr_mestre	cliente_matriz	clientes.cod_cliente_matriz	Aceita branco
lr_mestre	data_fundacao	clientes.dat_fundacao	Aceita branco, formato 'YYYY-MM-DD' - Y = ano, M=mês e D = Dia
lr_mestre	descricao_marca	clientes.den_marca	Aceita branco
lr_mestre	portador	clientes.cod_portador	Aceita branco
lr_mestre	tipo_portador	clientes.ies_tip_portador	Aceita branco
lr_mestre	cliente_terceiro	CHAR(01)	Aceita branco
lr_mestre	identificador_estrangeiro	vdp_cli_fornec_cpl.iden_estrangeiro	Aceita branco
lr_mestre	consignatario	clientes.cod_consig	Aceita branco
lr_info_fiscal	cnpj_cpf	clientes.num_cgc_cpf	Obrigatório
lr_info_fiscal	inscricao_estadual	clientes.ins_estadual	Aceita branco
lr_info_fiscal	ins_municipal	CHAR(20)	Aceita branco
lr_info_fiscal	micro_empresa	CHAR(01)	Aceita branco
lr_info_fiscal	data_micro_empresa	DATE	Aceita branco
lr_info_fiscal	zona_franca	clientes.ies_zona_franca	Obrigatório, 'S' para sim e 'N' para não
lr_info_fiscal	numero_suframa	clientes.num_suframa	Aceita branco, obrigatório se zona_franca = 'S'.
lr_info_fiscal	validade_suframa	DATE	Aceita branco, obrigatório se zona_franca = 'S'.
lr_info_fiscal	cprb	vdp_cli_fornec_cpl.ind_cprb	Aceita branco, 'S' para sim e 'N' para não
lr_info_fiscal	tipo_servico	vdp_cli_fornec_cpl.tipo_servico	Aceita branco
lr_info_fiscal	inovar_auto	CHAR(01)	Aceita branco, 'S' para sim e 'N' para não
lr_contato	caixa_postal	clientes.num_caixa_postal	Aceita branco
lr_contato	telex	clientes.num_telex	Aceita branco
lr_contato	ddi	CHAR(03)	Aceita branco
lr_contato	ddd	CHAR(03)	Aceita branco
lr_contato	telefone	clientes.num_telefone	Aceita branco
lr_contato	fax	clientes.num_fax	Aceita branco
lr_endereco	tipo_logradouro	vdp_cli_fornec_cpl.tip_logradouro	Aceita branco
lr_endereco	logradouro	vdp_cli_fornec_cpl.logradouro	Obrigatório
lr_endereco	numero_identificacao	vdp_cli_fornec_cpl.num_iden_lograd	Obrigatório
lr_endereco	complemento	vdp_cli_fornec_cpl.compl_endereco	Aceita branco
lr_endereco	cep	clientes.cod_cep	Obrigatório
lr_endereco	bairro	clientes.den_bairro	Aceita branco
lr_endereco	cidade_ibge	obf_cidade_ibge.cidade_ibge	Obrigatório
lr_localidade	rota	clientes.cod_rota	Aceita branco
lr_localidade	praca	clientes.cod_praca	Aceita branco
lr_localidade	local	clientes.cod_local	Obrigatório
lr_localidade	mercado	cli_dist_geog.cod_mercado	Aceita branco
lr_localidade	continente	cli_dist_geog.cod_continente	Aceita branco
lr_localidade	regiao	cli_dist_geog.cod_regiao	Aceita branco
lr_canal_venda	nivel_1	cli_canal_venda.cod_nivel_1	Aceita branco
lr_canal_venda	nivel_2	cli_canal_venda.cod_nivel_2	Aceita branco
lr_canal_venda	nivel_3	cli_canal_venda.cod_nivel_3	Aceita branco
lr_canal_venda	nivel_4	cli_canal_venda.cod_nivel_4	Aceita branco
lr_canal_venda	nivel_5	cli_canal_venda.cod_nivel_5	Aceita branco
lr_canal_venda	nivel_6	cli_canal_venda.cod_nivel_6	Aceita branco
lr_canal_venda	nivel_7	cli_canal_venda.cod_nivel_7	Aceita branco
lr_canal_venda	carteira	cli_canal_venda.cod_tip_carteira	Obrigatório

Exemplo de JSON enviado como parâmetro de entrada:

{

"lr_principal": {

"empresa": "50",

"usuario": "admlog"

},

"lr_mestre": {

"codigo": "",

"nome": " TESTE NOVO CLIENTE V2 CATINI",

"nome_reduzido": " TESTE NOVO CLIENTE V2 CATINI",

"nome_contato": "",

"situacao": "A",

"tipo_cliente": "01",

"frete_posto": "",

"classe": "1",

"cliente_matriz": "CATINI",

"data_fundacao": "2018-01-01",

"descricao_marca": "CATINI'S CORP",

"portador": "1",

"tipo_portador": "B",

"cliente_terceiro": "N",

"identificador_estrangeiro": "",

"consignatario": ""

},

"lr_info_fiscal": {

"cnpj_cpf": "021.033.831/0001-30",

"inscricao_estadual": "ISENTO",

"ins_municipal": "",

"micro_empresa": "S",

"data_micro_empresa": "2018-01-01",

"zona_franca": "N",

"numero_suframa": "",

"validade_suframa": "",

"cprb": "N",

"tipo_servico": "",

"inovar_auto": "N"

},

"lr_contato": {

"caixa_postal": "",

"telex": "",

"ddi": "",

"ddd": "",

"telefone": "(47)9.9730-7274",

"fax": ""

},

"lr_endereco": {

"tipo_logradouro": "RUA",

"logradouro": "São Paulo",

"numero_identificacao": "3712",

"complemento": "",

"cep": "89247-000",

"bairro": "Petrópolis",

"cidade_ibge": "4209102"

},

"lr_localidade": {

"rota": "288",

"praca": "288",

"local": "288",

"mercado": "01",

"continente": "1",

"regiao": "1"

},

"lr_canal_venda": {

"nivel_1": "",

"nivel_2": "",

"nivel_3": "",

"nivel_4": "",

"nivel_5": "",

"nivel_6": "",

"nivel_7": "",

"carteira": "10"

}

Parâmetros de saída:

Chave	Parâmetro	Parâmetro	Definição	Observação
status			SMALLINT	TRUE (processou) / FALSE (não processou)
msg			CHAR(200)	Retorna msg fixa caso ocorra algum erro.
data			RECORD
	cliente		clientes.cod_cliente	Retorna o código do cliente incluso ou branco/nulo quando ocorreu erro.
	count_mensagens		SMALLINT	Quantidade de mensagens de retorno
	mensagens		RECORD ARRAY	N/C
		texto	CHAR(2000)	Retorna a mensagem de erro, quando ocorre.