Histórico da Página
...
Objetivo: Enviar ao TAF as informações necessários para o SETUP do ambiente de forma a configurar o ambiente automaticamente e deixá-lo totalmente operacional.
Métodos: POST
Configurações do Serviço
A Configuração do serviço REST está documentada no link Configuração REST SERVER - Protheus.
Estas parametrizações estão localizadas fisicamente no arquivo appserver.ini da pasta de instalação "[...]\BIN\APP"
Importante
Na seção HTTPURI, a chave PrepareIn deve ser comentada.
Controle timeout: Para melhor sincronismo entre as aplicações, o serviço de SETUP possui um controle de processamento de 50 empresas por requisição; ao atingir essa limitação, o resposta do POST contém as empresas que foram processadas para que a origem as trate, antes de uma nova solicitação com as empresas restantes; assim deve se repetir até que todas as empresas sejam processadas.
Configurações do Serviço
A Configuração do serviço REST está documentada no link Configuração REST SERVER - Protheus.
Estas parametrizações estão localizadas fisicamente no arquivo appserver.ini da pasta de instalação "[...]\BIN\APP"
Importante
Na seção HTTPURI, a chave PrepareIn deve ser comentada.
Segue exemplo de configuração do WS REST para utilização Segue exemplo de configuração do WS REST para utilização no modulo TAF:
[HTTPV11]
SOCKETS=HTTPREST
ENABLE=1
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{"empresas": [ {{"empresas": [ { "CODEMPRESA": "",- Código único da empresa, character(4) - Obrigatório "CODFILIAL": "", - Código único da filial, Character(6) - Obrigatório "M0_FILIAL": "", - Descrição da Filial, Character(40) - Obrigatório "M0_NOME": "", - Nome da Empresa, Character(40) - Obrigatório "M0_NOMECOM": "", - Razao Social Empresa, Character(60) - Opcional - Se não enviado, considera o mesmo conteúdo do atributo M0_NOME "M0_ENDCOB": "", - Endereço Cobrança, Character(60) - Opcional "CODEMPRESAM0_CIDCOB": "", - Código único da empresaCidade Cobrança, characterCharacter(460) - Opcional "CODFILIALM0_ESTCOB": "", - Código único da filialEstado Cobrança, Character(62) - Opcional "M0_FILIALCEPCOB": "", - DescriçãoCEP da FilialCobrança, Character(418) - Opcional "M0_NOMEBAIRCOB": "", - NomeBairro da EmpresaCobrança, Character(4035) - Opcional "M0_NOMECOMCOMPCOB": "", - RazaoComplemento Social EmpresaCobrança, Character(6025) - Opcional "M0_CODMUN": "", - SeCodigo não enviadoMunicipio, considera o mesmo conteúdo do atributo M0_NOMECharacter(7) - Obrigatório "M0_ENDCOBENDENT": "", - Endereço CobrançaEntrega, Character(60) - Opcional "M0_CIDCOBCIDENT": "", - Cidade CobrançaEntrega, Character(60) - Opcional "M0_ESTCOBESTENT": "", - Estado CobrançaEntrega, Character(2) - Opcional "M0_CEPCOBCEPENT": "", - CEP CobrançaEntrega, Character(8) - Opcional "M0_BAIRCOBBAIRENT": "", - Bairro CobrançaEntrega, Character(35) - Opcional "M0_COMPCOBCOMPENT": "", - Complemento CobrançaEntrega, Character(25) - Opcional "M0_CODMUNTPINSC": "", - Codigo Municipio, Character(7) Tipo de Inscrição, Integer(1), 1-CEI, 2-CNPJ, 3-CPF, 4-INCRA - Obrigatório "M0_ENDENTCGC": "", - Endereço Entrega Numero da Inscrição acima, Character(6014) - Opcional "M0_CIDENT": "", - Cidade Entrega, Character(60) - Opcional Condicional ao atributo M0_TPINSC, - Obrigatório (este deve estar preenchido quando for 2, 3 ou 4) "M0_ESTENTCEI": "", - EstadoNumer EntregaCEI, Character(2) 12) - Condicional ao atributo M0_TPINSC, este deve estar preenchido quando for 1 "M0_CEPENTINSC": "", - Numero CEPInscrição EntregaEstadual, Character(814) - Opcional "M0_BAIRENT": "", - Bairro Entrega, Character(35) - Opcional - Caso não seja enviado, será informado "ISENTO" como default "M0_COMPENTINSCM": "", - Inscrição municipal Complementodo Entregaestabelecimento, Character(25) - Opcional "M0_TPINSCTEL": "", - Tipo de InscriçãoTelefone, Integer(1), 1-CEI, 2-CNPJ, 3-CPF, 4-INCRACharacter(14) "M0_CGCFAX": "", - Numero da Inscrição acimaFAX, Character(14) - Condicional ao atributo M0_TPINSC, este deve estar preenchido quando for 2, 3 ou 4Opcional "M0_CEIPRODRUR": "", - NumerProdutor CEIRural, Character(12) - Condicional ao atributo M0_TPINSC, este deve estar preenchido quando for 11), 1-Fisica, 2-Juridica, 3-Segurado Especial - Opcional "M0_INSCCNAE": "", - NumeroCodigo Inscriçãode Estadualatividade, Character(147) - Opcional - Caso não seja enviado, será informado "ISENTO" como default "M0_INSCMFPAS": "", - Inscrição municipal do estabelecimentoCódigo FPAS, Character(254) - Opcional "M0_TELNATJUR": "", - Natureza TelefoneJuridica, Character(144) - Opcional "M0_FAXNIRE": "", - FAX Numero NIRE(Nr. Identificacao do Registro da Empresa), Character(1425) - Opcional "M0_PRODRURDTRE": "", - Produtor RuralData NIRE(Inscricao na Junta Comercial), Character(1), 1-Fisica, 2-Juridica, 3-Segurado Especial8), AAAAMMDD - Opcional "M0_CNAEINS_SUF": "", - CodigoNumero deInscrição atividadeSUFRAMA, Character(712) - Opcional "M0C1E_FPASCODFIL": "", - Código FPAS, Character(4) - Opcional - Filial Referencia com ERP - Character(40) - Obrigatório "C1E_MATRIZ": true/false, - Obrigatório "M0C1E_NATJURDTINI": "", - PerÝodo NaturezaInicial JuridicaValidade, Character(46), MMAAAA - Opcional "M0C1E_NIREDESFOL": "", - Numero NIRE(Nr. Identificacao do Registro da Empresa), Character(25) Indic. DesoneraþÒo Folha, Character(1), 0=Nao Aplicavel;1=Empresa enquadrada nos art. 7. a 9. da Lei 12.546/2011 - Opcional - Opcional "M0C1E_DTREREGELT": "", - Registro DataEletronico, NIRE(Inscricao na Junta Comercial), Character(8), AAAAMMDDCharacter(1), 0=Nao optou pelo registro eletronico de empregados;1=Optou pelo registro eletronico de empregados - Opcional "M0C1E_INS_SUFSEGMEN": "", - NumeroSegmento Inscriçãode SUFRAMAAtividade, Character(12) - Opcional "C1E_CODFIL": "", - Filial Referencia com ERP - Character(40)1), 1=Instituiþ§es Financeiras - Bancos;2=ËrgÒos P·blicos;3=Portos - CODESP;4=ConstruþÒo Civil - Empreiteiras - Opcional "C1E_MATRIZENTEDU": true/false, "C1E_DTINI": "", - PerÝodo Inicial Validade, Character(6), MMAAAA Ind. Entidade Educativa, Character(1), 0=NÒo Ú entidade educativa sem fins lucrativos;1=╔ entidade educativa sem fins lucrativos - Opcional "C1E_DESFOLINDETT": "", - Indic Empresa Trab. DesoneraþÒo FolhaTemp., Character(1), 01=Nao AplicavelSim;1=Empresa enquadrada nos art. 7. a 9. da Lei 12.546/2011 - Opcional2=Não - Opcional - Default '2' "C1E_NRETT": "", - N·m Reg. Emp. Trab. Tempo, Character(30) - Opcional "C1E_REGELTSIGMIN": "", - Registro Eletronico Ident Min/Lei Conc Certif, Character(170), 0=Nao optou pelo registro eletronico de empregados;1=Optou pelo registro eletronico de empregados- Opcional "C1E_NRCERT": "", - N·mero do Certificado, Character(40) - Opcional "C1E_SEGMENDTEMCE": "", - SegmentoData deemissÒo Atividadecertificado, Character(18), 1=Instituiþ§es FinanceirasAAAAMMDD - Bancos;2=ËrgÒos P·blicos;3=Portos - CODESP;4=ConstruþÒo Civil - EmpreiteirasOpcional "C1E_DTVCCE": "", - Data Vencimento Certif., Character(8), AAAAMMDD - Opcional "C1E_ENTEDUNRPRRE": "", - N·mero IndProtoc. Entidade EducativaRenovaþÒo, Character(140), 0=NÒo Ú entidade educativa sem fins lucrativos;1=╔ entidade educativa sem fins lucrativos - Opcional "C1E_DTPRRE": "", - Data Protocolo RenovaþÒo, Character(8), AAAAMMDD - Opcional "C1E_INDETTDTDOU": "", - Indic Empresa TrabDt.PublicaþÒo Temp.DOU, Character(18), 1=Sim;2=NÒoAAAAMMDD - Opcional "C1E_PAGDOU": - Default '2'"", - N·mero da Pßgina do DOU, Character(5) - Opcional "C1E_NRETTSIAFI": "", - N·mN·mero Reg. Emp. Trab. Tempodo SIAFI, Character(306) - Opcional "C1E_SIGMINRPPS": "", - Ident Min/Lei Conc CertifRegime Prop. Prev. Social, Character(701), 1=Sim;2=NÒo - Opcional "C1E_NRCERTEFR": "", - N·mero do Certificado, Character(40) ËrgÒo P·blico Ú o EFR, Character(1), 1=Sim;2=NÒo - Opcional "C1E_DTEMCECPNJER": "", - CNPJ DataEnte emissÒoFederativo certificadoResp, Character(814), AAAAMMDD - Opcional "C1E_DTVCCENMENTE": "", - Nome Datado VencimentoEnte Certif.Federativo, Character(8115), AAAAMMDD - Opcional "C1E_NRPRRESUBTET": "", - N·mero Protoc. RenovaþÒo, Character(40) Subteto, Character(1), 1=Executivo;2=Judicißrio;3=Legislativo;9=Todos os poderes - Opcional "C1E_DTPRREVLRSUB": "", - Valor DataSubteto ProtocoloEnte RenovaþÒoFedera, CharacterDecimal(8), AAAAMMDD14,2) - Opcional "C1E_DTDOUSITESP": "", - Dt.PublicaþÒo DOU, Character(8), AAAAMMDD SituaþÒo Pessoa JurÝdica, Character(1),0=SituaþÒo Normal;1=ExtinþÒo;2=FusÒo;3=CisÒo;4=IncorporaþÒo. - Opcional "C1E_PAGDOUSITPF": "", - N·meroSituaþÒo da Pßgina do DOUPessoa FÝsica, Character(51) - Opcional "C1E_SIAFI": "", - N·mero do SIAFI, Character(6),0=SituaþÒo Normal;1=Encerramento de esp¾lio;2=SaÝda do paÝs em carßter permanente - Opcional "C1E_RPPSCNPJTR": "", - RegimeCNPJ Prop.do Prev. SocialTransmissor (Outorga), Character(1), 1=Sim;2=NÒo14) - OpcionalObrigatório "C1E_EFRUF": "", - ËrgÒoUF P·blicodo ÚEnte o EFRFederativo, Character(1), 1=Sim;2=NÒo2) - OpcionalObrigatório "C1E_CPNJERdataInicioeSocial": "AAAAMMDD", certificado[ - CNPJSomente para Ente Federativo Resp, Character(14) - Opcionalestabelecimento Matriz. {"arquivo": "String"}, {"senha": "String"} ], "C1E_NMENTEdataInicioReinf": "AAAAMMDD", - Nome do Ente Federativo, Character(115) - Opcional "C1E_SUBTET": "", - Subteto, Character(1), 1=Executivo;2=Judicißrio;3=Legislativo;9=Todos os poderes - Opcional "C1E_VLRSUB": "", - Valor Subteto Ente Federa, Decimal(14,2) - Opcional "C1E_SITESP": "", - SituaþÒo Pessoa JurÝdica, Character(1),0=SituaþÒo Normal;1=ExtinþÒo;2=FusÒo;3=CisÒo;4=IncorporaþÒo. - Opcional "C1E_SITPF": "", - SituaþÒo Pessoa FÝsica, Character(1),0=SituaþÒo Normal;1=Encerramento de esp¾lio;2=SaÝda do paÝs em carßter permanente - Opcional "C1E_CNPJTR":"", - CNPJ do Transmissor (Outorga), Character(14) - Opcional "C1E_UF": "", - UF do Ente Federativo, Character(2) - Obrigatório "dataInicioeSocial": "AAAAMMDD", certificado[ - Somente para estabelecimento Matriz. {"arquivo": "String"}, {"senha": "String"} ] } ], "schedule": [ {"scheduleIntegracao": "1-Sim/2-Nao"}, - Ativação da Integração ERP / TAF - Charater(1) {"scheduleValidacao": "1-Sim/2-Nao"}, - Ativação da Validação ERP / TAF - Charater(1) {"scheduleTransmissao": "1-Sim/2-Nao"} - Ativação da Integração TAF / União - Charater(1) ], "usuarios": [ {"email": ""}, {"email": ""}, {"email": ""} ], "versaoVigenteeSocial": "" - Versão eSocial 02_04_01 ou 02_04_02, Character(8) 'urlSmartClient ' : "" - Endereço do Endpoint de acesso ( Smartclient HTML - Webapp) } } ], "schedule": [ {"scheduleIntegracao": "1-Sim/2-Nao"}, - Ativação da Integração ERP / TAF - Charater(1) {"scheduleValidacao": "1-Sim/2-Nao"}, - Ativação da Validação ERP / TAF - Charater(1) {"scheduleTransmissao": "1-Sim/2-Nao"} - Ativação da Integração TAF / União - Charater(1) ], "usuarios": [ {"email": ""}, - Obrigatório {"email": ""}, - Obrigatório {"email": ""} - Obrigatório ], "versaoVigenteeSocial": "" - Versão eSocial 02_04_01 ou 02_04_02, Character(8) - Obrigatório "urlSmartClient" : "", - Endereço do Endpoint de acesso ( Smartclient HTML - Webapp) - Obrigatório "versaoVigenteReinf": "" - Versão EFD Reinf 1_03_02, Character(8) - Obrigatório } |
Bloco de código | ||||
---|---|---|---|---|
| ||||
Validação de Layout:
Retorno:
{
"empresas": [
{
"TipoEnviado": "", - Tipo do Dado Enviado Character(1)
"Filial": "", - Filial da Empresa Enviada Character(6)
"TamanhoEnviado": 14, - Tamanho do dado Enviado Character(6)
"Empresa": "igF2", - Empresa Enviada Character(4)
"Campo": "C1E_CPNJER", -- Campo Enviado Character(15) | ||||
Bloco de código | ||||
| ||||
Validação de Layout: Retorno: { "empresas": [ { "TipoEnviadoStatusTamanho": ""true, - TipoProblema dodetectado Dadofor Enviado Character(1)Tamanho Boolean "FilialStatusTipo": "",false - Filial da Empresa Enviada Character(6) Problema detectado for Tipo Boolean } ] } Log internos do ambiente { "TamanhoEnviadoLogs": [ 14, - Tamanho do dado Enviado Character(6){ "Empresaempresas": "igF2", - [ Empresa Enviada Character(4) { "Campo": "C1E_CPNJER", -- Campo Enviado Character(15) "StatusTamanhomensagem": true, - Problema detectado for Tamanho Boolean"", "StatusTipo": false - Problema detectado for Tipo Boolean"status": "", } ] } Log internos do ambiente { "Logsfilial": ["", { "empresasempresa": ["" {}, ] "mensagem": ""}, { "statususuarios": "",{ "filialusuarios": "",[ "empresa": ""{ }, ]"usuario": "", }, { "usuariossenha": {"" "usuarios": [ }, { "usuario": "", "senha": "" }, { "usuario": "", "senha": "" }, { "usuario": "TAF_WS", "senha": "" } ] } } ] } |
...