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

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.

...

Bloco de código

language	js
theme	Eclipse
title	Exemplo POST:

{"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) - Condicional ao atributo M0_TPINSC, - Obrigatório (este deve estar preenchido quando for 2, 3 ou 4, 3 ou 4)
			"M0_CEI": "",		- Numer CEI, Character(12) - Condicional ao atributo M0_TPINSC, este deve estar preenchido quando for 1
			"M0_CEIINSC": "",		- Numero NumerInscrição CEIEstadual, Character(1214) - Opcional	- Condicional ao atributo M0_TPINSC, este deve estar preenchido quando for 1 Caso não seja enviado, será informado "ISENTO" como default
			"M0_INSCM": "",		- Inscrição municipal do estabelecimento, Character(25) - Opcional
			"M0_INSCTEL": "",		- Numero Inscrição EstadualTelefone, Character(14) - Opcional
			"M0_FAX": "",		- Caso não seja enviadoFAX, será informado "ISENTO" como defaultCharacter(14) - Opcional
			"M0_INSCMPRODRUR": "",		- Inscrição municipal do estabelecimentoProdutor Rural, Character(251), 1-Fisica, 2-Juridica, 3-Segurado Especial - Opcional
			"M0_TELCNAE": "",		- Codigo de Telefoneatividade, Character(147) - Opcional
			"M0_FAXFPAS": "",		- FAXCódigo FPAS, Character(144) - Opcional
			"M0_PRODRURNATJUR": "",	- Produtor Rural, Character(1), 1-Fisica, 2-Juridica, 3-Segurado EspecialNatureza Juridica, Character(4) - Opcional
			"M0_CNAENIRE": "",		- Codigo de atividadeNumero NIRE(Nr. Identificacao do Registro da Empresa), Character(725) - Opcional
			"M0_FPASDTRE": "",		- Código FPAS Data NIRE(Inscricao na Junta Comercial), Character(48), AAAAMMDD - Opcional
			"M0_INS_NATJURSUF": "", 	- Numero NaturezaInscrição JuridicaSUFRAMA, Character(412) - Opcional Opcional
			
			"M0C1E_NIRECODFIL": "",		 - Numero NIRE(Nr. Identificacao do Registro da Empresa),Filial Referencia com ERP - Character(25)40) - Obrigatório
			"C1E_MATRIZ": true/false, - OpcionalObrigatório
			"M0C1E_DTREDTINI": "",		- Data NIRE(Inscricao na Junta Comercial)PerÝodo Inicial Validade, Character(86), AAAAMMDDMMAAAA - Opcional
			"M0C1E_INS_SUFDESFOL": "", 	- NumeroIndic. InscriçãoDesoneraþÒo SUFRAMAFolha, Character(12)1), 0=Nao Aplicavel;1=Empresa enquadrada nos art. 7. a 9. da Lei 12.546/2011 - Opcional - Opcional
			
			"C1E_CODFILREGELT": "", -  Filial Referencia com ERP - Character(40)
			"C1E_MATRIZ": true/false,				- Registro Eletronico, Character(1), 0=Nao optou pelo registro eletronico de empregados;1=Optou pelo registro eletronico de empregados - Opcional
			"C1E_DTINISEGMEN": "",	- PerÝodoSegmento Inicialde ValidadeAtividade, Character(61), MMAAAA 1=Instituiþ§es Financeiras - Bancos;2=ËrgÒos P·blicos;3=Portos - CODESP;4=ConstruþÒo Civil - Empreiteiras - Opcional
			"C1E_DESFOLENTEDU": "",	- IndicInd. DesoneraþÒoEntidade FolhaEducativa, Character(1), 0=Nao Aplicavel;1=Empresa enquadrada nos art. 7. a 9. da Lei 12.546/2011 - OpcionalNÒo Ú entidade educativa sem fins lucrativos;1=╔ entidade educativa sem fins lucrativos - Opcional
			"C1E_REGELTINDETT": "",	- Registro Eletronico Indic Empresa Trab. Temp., Character(1), 0=Nao optou pelo registro eletronico de empregados;1=Optou pelo registro eletronico de empregados - Opcional1=Sim;2=Não - Opcional - Default '2'
			"C1E_SEGMENNRETT": "",	- Segmento de Atividade N·m Reg. Emp. Trab. Tempo, Character(130), 1=Instituiþ§es Financeiras - Bancos;2=ËrgÒos P·blicos;3=Portos - CODESP;4=ConstruþÒo Civil - Empreiteiras- Opcional
			"C1E_SIGMIN": "",	- Ident Min/Lei Conc Certif, Character(70) - Opcional
			"C1E_ENTEDUNRCERT": "",	- Ind.N·mero Entidadedo EducativaCertificado, Character(140), 0=NÒo Ú entidade educativa sem fins lucrativos;1=╔ entidade educativa sem fins lucrativos- Opcional
			"C1E_DTEMCE": "",	- Data emissÒo certificado, Character(8), AAAAMMDD - Opcional
			"C1E_INDETTDTVCCE": "",	- IndicData Empresa Trab. TempVencimento Certif., Character(18), 1=Sim;2=NÒoAAAAMMDD - Opcional
			"C1E_NRPRRE": "",	- Default '2' N·mero Protoc. RenovaþÒo, Character(40) - Opcional
			"C1E_NRETTDTPRRE": "",	- N·mData Reg. Emp. Trab. TempoProtocolo RenovaþÒo, Character(308), AAAAMMDD - Opcional
			"C1E_SIGMINDTDOU": "",	- Ident Min/Lei Conc CertifDt.PublicaþÒo DOU, Character(708), AAAAMMDD - Opcional
			"C1E_NRCERTPAGDOU": "",	- N·mero da Pßgina do CertificadoDOU, Character(405) - Opcional
			"C1E_DTEMCESIAFI": "", 	- DataN·mero emissÒodo certificadoSIAFI, Character(86), AAAAMMDD - Opcional
			"C1E_DTVCCERPPS": "", 	- DataRegime VencimentoProp. CertifPrev. Social, Character(81), AAAAMMDD1=Sim;2=NÒo - Opcional
			"C1E_NRPRREEFR": "", 		- ËrgÒo P·blico N·meroÚ Protoc.o RenovaþÒoEFR, Character(401), 1=Sim;2=NÒo - Opcional
			"C1E_DTPRRECPNJER": "", 	- CNPJ DataEnte ProtocoloFederativo RenovaþÒoResp, Character(814), AAAAMMDD - Opcional
			"C1E_DTDOUNMENTE": "", 	- Dt.PublicaþÒo DOU Nome do Ente Federativo, Character(8115), AAAAMMDD - Opcional
			"C1E_PAGDOUSUBTET": "", 	- N·mero da Pßgina do DOUSubteto, Character(5)1), 1=Executivo;2=Judicißrio;3=Legislativo;9=Todos os poderes - Opcional
			"C1E_SIAFIVLRSUB": "", 	- N·meroValor Subteto doEnte SIAFIFedera, CharacterDecimal(614,2) - Opcional
			"C1E_RPPSSITESP": "", 	- Regime Prop.SituaþÒo Prev.Pessoa SocialJurÝdica, Character(1),0=SituaþÒo Normal;1=SimExtinþÒo;2=NÒoFusÒo;3=CisÒo;4=IncorporaþÒo. - Opcional
			"C1E_EFRSITPF": "", 		- ËrgÒoSituaþÒo P·blico Ú o EFRPessoa FÝsica, Character(1), 1=Sim;2=NÒo,0=SituaþÒo Normal;1=Encerramento de esp¾lio;2=SaÝda do paÝs em carßter permanente - Opcional
			"C1E_CPNJERCNPJTR": "", 	- CNPJ Entedo FederativoTransmissor Resp(Outorga), Character(14) - OpcionalObrigatório
			"C1E_NMENTEUF": "",       	- NomeUF do Ente Federativo, Character(115) - Opcional2) - Obrigatório
			"dataInicioeSocial": "AAAAMMDD",
			certificado[			- Somente para estabelecimento Matriz.
				{"C1E_SUBTETarquivo": "String"},
				{"senha": 	- 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)
}"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

language	js
title	Estrutura da mensagem de retorno do POST (Response):

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

language	js
title	Estrutura da mensagem de retorno do POST (Response):

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": ""
                    }
                ]
            }
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 25

Nova versão Atual

Chave

Configurações do Serviço

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 25

Nova versão Atual

Chave

Configurações do Serviço