O que é a integração via API do NDD Print 360?
A integração via API conecta os dados do NDD Print Portal 360 a sistemas externos por meio de Web Services SOAP.
Com ela, é possível consultar e tratar automaticamente informações de trabalhos de impressão e cotas, sem a necessidade de exportar relatórios manualmente.
Quais são os principais benefícios?
A integração permite:
-
automatizar o consumo de dados por sistemas de BI, ERP, financeiro ou portais internos;
-
reduzir atividades manuais de exportação, tratamento e consolidação de relatórios;
-
consultar somente os dados necessários, utilizando filtros de data e campos específicos;
-
apoiar análises de custos, volumetria, comportamento de impressão e acompanhamento de cotas;
-
integrar processos de gestão de impressão às rotinas já utilizadas pelo cliente.
Quais informações podem ser consultadas?
A API permite consultar informações dos trabalhos de impressão, como:
-
usuário e domínio;
-
conta de custos;
-
equipamento e fila de impressão;
-
site e departamento;
-
páginas monocromáticas e coloridas;
-
custos;
-
modo simplex ou duplex;
-
data de impressão;
-
aplicativo de origem;
-
título do documento.
Os campos retornados dependem daqueles selecionados na consulta.
Quais métodos estão disponíveis para consulta de dados?
PrintJobsData
GetPrintJobs
Retorna os trabalhos de impressão conforme os filtros informados.
É indicado para integrações de relatórios, BI, auditoria, rateio de custos e análise de volumetria.
A consulta permite definir:
-
a data;
-
o tipo de filtro, que pode ser data de impressão ou data de inclusão;
-
os campos que deverão ser retornados.
QuotasData
GetBalance
Retorna o saldo de cotas do usuário, incluindo créditos corporativos e pessoais, por páginas, cor ou valor.
É indicado para portais internos, consultas de saldo, painéis de acompanhamento e integrações com processos de controle de impressão.
QuotasWS
GetUserQuotas
Retorna o total de cotas por usuário e permite aplicar filtros por conta, tipo de cota, saldo, créditos, débitos e cotas expiradas.
É indicado para acompanhamento gerencial, conferência de consumo e integração com sistemas de gestão de usuários ou centros de custo.
A API também permite alterar cotas?
Sim. O Web Service QuotasData disponibiliza métodos para adicionar ou remover créditos:
-
AddCreditTotalPages; -
AddCreditColor; -
AddCreditMoney; -
DebitTotalPages; -
DebitColor; -
DebitMoney.
Esses métodos devem ser utilizados somente quando houver uma regra de negócio definida e validada, pois alteram as cotas dos usuários.
A integração pode ser utilizada no Power BI?
Sim. Para isso, é necessário desenvolver um integrador ou processo de ETL capaz de consumir os Web Services, tratar os retornos e disponibilizar os dados no Power BI.
A documentação descreve Web Services SOAP com retorno em JSON. Não há indicação de um conector nativo e automático do NDD Print 360 para o Power BI.
Como os dados são retornados?
Os Web Services retornam uma string em formato JSON. A aplicação integradora pode desserializar esses dados e direcioná-los para uma base de dados, dashboard, ERP ou outra ferramenta de análise.
Quais informações são necessárias para autenticação?
As consultas utilizam informações da empresa, como nome e chave, além de um usuário com as permissões necessárias.
A senha deve ser informada de forma criptografada, conforme os exemplos disponibilizados no Integration Kit.
Há alguma configuração adicional para consultar cotas por usuário?
Sim. Para utilizar o método GetUserQuotas em ambientes locais, é necessário:
-
utilizar o NDD Print Portal 360 Local na versão 5.65.13;
-
configurar a API QuotasWS no IIS do servidor.
Quais cuidados devem ser adotados?
-
Solicitar somente os campos necessários para a integração.
-
Evitar consultas excessivas ou sem filtros, principalmente em ambientes com alto volume de impressão.
-
Proteger as credenciais e a chave da empresa.
-
Avaliar a necessidade de acesso ao título dos documentos, considerando as políticas de privacidade do cliente.
-
Tratar os retornos de erro da API, incluindo falhas de autenticação, permissões insuficientes ou limite diário de acessos.
Onde consultar a documentação técnica?
A documentação completa, incluindo WSDLs, parâmetros, campos de retorno, exemplos de criptografia e possíveis erros, está disponível no Integration Kit.