747 Business Intelligence/Integracao BI WEB Services

747_Business_Intelligence

Você poderá criar relatórios e vincula-los em outros sistemas de forma dinâmica, via comunicação por API. Além de outros softwares de análise, podemos citar:

• Integração com Excel. Pesquise no Google, "Integração Excel API Rest" e encontrará diversos tutoriais
• Integração com PowerBI.

Basicamente, você precisa criar ou solicitar a criação de um relatório, principalmente no formato "Arquivo" a Touch Comp com os dados necessários a sua tarefa. Disponibilizamos endpoints que receberão os parâmetros necessários e assim retornarão os dados solicitados.

Endpoints/Web services

Existem dois tipos de endpoints get e post. Get é aconselhável principalmente no caso de integrações realizadas por usuários convencionais, como utilizando Excel ou PowerBI. Por outro lado, o post pode ser mais interessante para desenvolvedores integrarem seus sistemas.

Vale lembrar que você deve-se autenticar para ter acesso a estes dois endpoints. Consulte Integracao_Web_Services para saber como se autenticar para ter acesso aos endpoints.

Requisição get

• url = http://{host:porta}/touch-erp/auth/business-intelligence/exportar-dados/json/{idBI}/{parametros}

Você informar o identificador do BI em {idBI}.

Informe os parâmetros do relatório, no formato de Map; chave=valor, onde estes parâmetros devem ser separados por &. Os parâmetros dependem do BI em questão, ou seja, cada BI possui seus próprios parâmetros. Veja uma URL de exemplo:

• url = http://touchcomp.ddns.me:8080/touch-erp/auth/business-intelligence/exportar-dados/json/56/P_DATA_CASDASTRO=2000-01-31T00&P_TIPO_TITULO_PAG_REC=1

Observe que neste exemplo temos o BI com identificador 56, que recebe os parâmetros P_DATA_CASDASTRO e P_TIPO_TITULO_PAG_REC.

Requisição post

Na requisição post, os dados são passados pelo conteúdo(body) da requisição, em formato de json. A URL:

• url = http://{host:porta}/touch-erp/auth/business-intelligence/exportar-dados/json/

Os arquivo seria:

{
	"input":{
		"idBi":872,
		"parametros":{
			"P_DATA_CASDASTRO":"2022-01-15T15-00",
           "P_TIPO_TITULO_PAG_REC":"1"
		}
	}
}

Parâmetros

Os parâmetros devem ser informados, no caso do json, em campos texto, mesmo se valores numéricos. O próprio BI irá realizar a conversão dos mesmos conforme o tipo de dado.

No caso de datas, os formatos aceitos são:

• yyyy-MM-ddTHH-mm -> 2022-01-31T23-58
• yyyy-MM-ddTHH -> 2022-01-31T23
• yyyy-MM-dd -> 2022-01-31
• number -> 1659495600000 (Milissegundo)