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.
Segue exemplo de configuração do WS REST para utilização no modulo TAF:
[HTTPV11]
SOCKETS=HTTPREST
ENABLE=1
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 no modulo TAF:
[HTTPV11]
SOCKETS=HTTPREST
ENABLE=1
[HTTPREST[HTTPREST]
Port=8080
URIs=HTTPURI
Security=0
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{"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(4140) - 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 "M0_CIDCOB": "", - Cidade Cobrança, Character(60) - Opcional "M0_ESTCOB": "", - Estado Cobrança, Character(2) - Opcional "M0_CEPCOB": "", - CEP Cobrança, Character(8) - Opcional "M0_BAIRCOB": "", - Bairro Cobrança, Character(35) - Opcional "M0_COMPCOB": "", - Complemento Cobrança, Character(25) - Opcional "M0_CODMUN": "", - Codigo Municipio, Character(7) - Obrigatório "M0_ENDENT": "", - Endereço Entrega, Character(60) - Opcional "M0_CIDENT": "", - Cidade Entrega, Character(60) - Opcional "M0_ESTENT": "", - Estado Entrega, Character(2) "M0_CEPENT": "", - CEP Entrega, Character(8) - Opcional "M0_BAIRENT": "", - Bairro Entrega, Character(35) - Opcional "M0_COMPENT": "", - Complemento Entrega, Character(25) - Opcional "M0_TPINSC": "", - Tipo de Inscrição, Integer(1), 1-CEI, 2-CNPJ, 3-CPF, 4-INCRA - Obrigatório "M0_CGC": "", - Numero da Inscrição acima, Character(14) "M0_INSC": "", - NumeroCondicional Inscriçãoao Estadual, Character(14) "M0_TEL": "", - Telefone, Character(14) "M0_FAX": "", - FAX, Character(14atributo M0_TPINSC, - Obrigatório (este deve estar preenchido quando for 2, 3 ou 4) "M0_PRODRURCEI": "", - ProdutorNumer RuralCEI, Character(112), 1-Fisica, 2-Juridica, 3-Segurado Especial Condicional ao atributo M0_TPINSC, este deve estar preenchido quando for 1 "M0_CNAEINSC": "", - CodigoNumero deInscrição atividadeEstadual, Character(7) "M0_FPAS": "", 14) - Opcional - Código FPAS, Character(4)Caso não seja enviado, será informado "ISENTO" como default "M0_NATJURINSCM": "", - Inscrição municipal Naturezado Juridicaestabelecimento, Character(425) - Opcional "M0_NIRETEL": "", - Numero NIRE(Nr. Identificacao do Registro da Empresa)Telefone, Character(2514) "M0_DTREFAX": "", - DataFAX, NIRE(Inscricao na Junta Comercial), Character(8), AAAAMMDDCharacter(14) - Opcional "M0_INS_SUFPRODRUR": "", - NumeroProdutor Inscrição SUFRAMARural, Character(12)1), 1-Fisica, 2-Juridica, 3-Segurado Especial - Opcional "M0_CEICNAE": "", - NumerCodigo de CEIatividade, Character(12) 7) - Opcional "C1EM0_CODFILFPAS": "", "C1E_MATRIZ": "true/false", - Código FPAS, Character(4) - Opcional "C1EM0_DTININATJUR": "", - PerÝodoNatureza Inicial ValidadeJuridica, Character(84), - AAAAMMDDOpcional "C1EM0_DESFOLNIRE": "", - Numero Indic. DesoneraþÒo FolhaNIRE(Nr. Identificacao do Registro da Empresa), Character(125), 0=Nao Aplicavel;1=Empresa enquadrada nos art. 7. a 9. da Lei 12.546/2011- Opcional "C1EM0_REGELTDTRE": "", - Registro Eletronico Data NIRE(Inscricao na Junta Comercial), Character(18), 0=NaoAAAAMMDD optou pelo registro eletronico de empregados;1=Optou pelo registro eletronico de empregados- Opcional "C1EM0_INS_SEGMENSUF": "", - SegmentoNumero deInscrição AtividadeSUFRAMA, Character(1), 1=Instituiþ§es Financeiras - Bancos;2=ËrgÒos P·blicos;3=Portos - CODESP;4=ConstruþÒo Civil - Empreiteiras12) - Opcional "C1E_ENTEDUCODFIL": "", - Ind. Entidade Educativa, Filial Referencia com ERP - Character(140), 0=NÒo Ú entidade educativa sem fins lucrativos;1=╔ entidade educativa sem fins lucrativos- Obrigatório "C1E_MATRIZ": true/false, - Obrigatório "C1E_INDETTDTINI": "", - IndicPerÝodo Empresa Trab. Temp.Inicial Validade, Character(16), 1=Sim;2=NÒoMMAAAA - Opcional "C1E_NRETTDESFOL": "", - N·m RegIndic. Emp. Trab. TempoDesoneraþÒo Folha, Character(30) "C1E_SIGMIN": "", - Ident Min/Lei Conc Certif, Character(70) "C1E_NRCERT": "", - N·mero do Certificado, Character(40)1), 0=Nao Aplicavel;1=Empresa enquadrada nos art. 7. a 9. da Lei 12.546/2011 - Opcional - Opcional "C1E_DTEMCEREGELT": "", - DataRegistro emissÒo certificadoEletronico, Character(81), AAAAMMDD "C1E_DTVCCE": "", - Data Vencimento Certif., Character(8), AAAAMMDD0=Nao optou pelo registro eletronico de empregados;1=Optou pelo registro eletronico de empregados - Opcional "C1E_NRPRRESEGMEN": "", - N·meroSegmento Protoc.de RenovaþÒoAtividade, Character(40) "C1E_DTPRRE": "", - Data Protocolo RenovaþÒo, Character(8), AAAAMMDD1), 1=Instituiþ§es Financeiras - Bancos;2=ËrgÒos P·blicos;3=Portos - CODESP;4=ConstruþÒo Civil - Empreiteiras - Opcional "C1E_DTDOUENTEDU": "", - DtInd.PublicaþÒo Entidade DOUEducativa, Character(81), AAAAMMDD "C1E_PAGDOU": "", - N·mero da Pßgina do DOU, Character(5)0=NÒo Ú entidade educativa sem fins lucrativos;1=╔ entidade educativa sem fins lucrativos - Opcional "C1E_SIAFIINDETT": "", - N·meroIndic do SIAFIEmpresa Trab. Temp., Character(6)1), 1=Sim;2=Não - Opcional - Default '2' "C1E_RPPSNRETT": "", - Regime PropN·m Reg. Emp. PrevTrab. SocialTempo, Character(130), 1=Sim;2=NÒo - Opcional "C1E_EFRSIGMIN": "", - ËrgÒoIdent P·blicoMin/Lei ÚConc o EFRCertif, Character(170), 1=Sim;2=NÒo - Opcional "C1E_CPNJERNRCERT": "", - CNPJN·mero Entedo Federativo RespCertificado, Character(1440) - Opcional "C1E_NMENTEDTEMCE": "", - NomeData doemissÒo Ente Federativocertificado, Character(115)8), AAAAMMDD - Opcional "C1E_SUBTETDTVCCE": "", - Subteto Data Vencimento Certif., Character(18), 1=Executivo;2=Judicißrio;3=Legislativo;9=Todos os poderesAAAAMMDD - Opcional "C1E_VLRSUBNRPRRE": "", - ValorN·mero Subteto Ente FederaProtoc. RenovaþÒo, DecimalCharacter(14,2)40) - Opcional "C1E_SITESPDTPRRE": "", - SituaþÒoData PessoaProtocolo JurÝdicaRenovaþÒo, Character(18),0=SituaþÒo Normal;1=ExtinþÒo;2=FusÒo;3=CisÒo;4=IncorporaþÒo. AAAAMMDD - Opcional "C1E_SITPFDTDOU": "", - SituaþÒo Pessoa FÝsicaDt.PublicaþÒo DOU, Character(18),0=SituaþÒo Normal;1=Encerramento de esp¾lio;2=SaÝda do paÝs em carßter permanente AAAAMMDD - Opcional "C1E_PAGDOU": "", - N·mero da Pßgina do DOU, Character(5) - Opcional "C1E_CNPJTRSIAFI": "", - CNPJN·mero do Transmissor (Outorga)SIAFI, Character(14) 6) - Opcional "dataInicioeSocialC1E_RPPS": "AAAAMMDD", certificado[ - Regime Prop. Prev. Social, Character(1), 1=Sim;2=NÒo - Opcional {"arquivoC1E_EFR": "String"}, {"senha": "String"} ] } ], "schedule": [ {"scheduleIntegração": "1-Sim/2-Nao"}, {"scheduleValidação": "1-Sim/2-Nao"}, {"scheduleTransmissão": "1-Sim/2-Nao"} ], "usuarios": [ {"email": ""}, {"email": ""}, {"email": ""} ], tabelasCompartilhadas:["empregador","estabelecimento","rubricas","turno","lotacao","cargos","carreira","funcoes","horarios","ambiente","processos","operadores","trabalhadores"], "versaoVigenteeSocial": "AAAAMMDD" }- ËrgÒo P·blico Ú o EFR, Character(1), 1=Sim;2=NÒo - Opcional "C1E_CPNJER": "", - CNPJ Ente Federativo Resp, Character(14) - Opcional "C1E_NMENTE": "", - 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) - Obrigatório "C1E_UF": "", - UF do Ente Federativo, Character(2) - Obrigatório "dataInicioeSocial": "AAAAMMDD", certificado[ - Somente para estabelecimento Matriz. {"arquivo": "String"}, {"senha": "String"} ], "dataInicioReinf": "AAAAMMDD", } ], "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)
"StatusTamanho": true, - Problema detectado for Tamanho Boolean
"StatusTipo": false - Problema detectado for Tipo Boolean
}
]
}
Log internos do ambiente
{
"Logs": [
{
"empresas": [
{
"mensagem": "",
"status": "",
"filial": "",
"empresa": ""
},
]
},
{
"usuarios": {
"usuarios": [
{
"usuario": "",
"senha": ""
},
{
"usuario": "",
"senha": ""
},
{
"usuario": "",
"senha": ""
},
{
"usuario": "TAF_WS",
"senha": ""
}
]
}
}
]
} | ||||
Bloco de código | ||||
| ||||
{{ "empresas" : { "CODEMPRESA":"",
"CODFILIAL":"",
"STATUS":"",
"log":
{"Rotina":"",
"Mensagem":"",
"TimeStamp":""
},
"TimeStamp":""
}
,
"usuarios":[
{ "usuario":"",senha: "",erro:""},
{ "usuario":"","senha": "",erro:""},
{"usuario":"","senha": "",erro:""}
]
}
|