O que é a integração via API do NDD Print MPS?
A integração via API permite conectar sistemas externos ao NDD Print MPS por meio dos Web Services disponibilizados no Integration Kit.
Com ela, é possível consultar informações e automatizar ações relacionadas a contratos, contadores, equipamentos, eventos, suprimentos, estoques, pedidos e NDD Print Host.
Quais são os principais benefícios da integração?
A integração permite:
-
automatizar atividades operacionais que antes dependiam de consultas e ações manuais no portal;
-
centralizar dados do MPS em sistemas próprios, como ERP, BI, CRM ou portais internos;
-
apoiar processos de gestão de contratos, faturamento, logística de suprimentos e acompanhamento de eventos;
-
criar fluxos integrados para demandas, pedidos, estoques e atendimentos;
-
receber notificações automáticas sobre eventos e alterações em pedidos.
Quais informações podem ser consultadas?
Dependendo do Web Service utilizado, é possível consultar informações como:
-
contratos, fechamentos e valores consolidados;
-
contadores de impressoras;
-
eventos de impressoras e eventos do sistema;
-
empresas, sites, departamentos, impressoras, fabricantes e modelos;
-
suprimentos, estoques, centros de distribuição e fornecedores;
-
pedidos de transferência e pedidos de fornecedores;
-
NDD Print Hosts e impressoras cadastradas para monitoramento por rede.
Quais Web Services estão disponíveis?
ContractsData
Permite consultar e gerenciar informações de contratos, impressoras vinculadas, fechamentos, valores consolidados e situações de equipamentos dentro ou fora de contrato.
CountersData
Permite consultar tipos de contadores, contadores simples e contadores de referência, além de possibilitar a inclusão de contadores quando aplicável ao fluxo de integração.
EventsData
Permite consultar eventos de impressoras e do sistema, além de executar ações como abrir, fechar, reabrir, ignorar, comentar ou aguardar a solução de eventos.
GeneralData e GeneralData2
Permitem consultar e gerenciar dados gerais do ambiente, incluindo empresas, impressoras, sites, departamentos, materiais, suprimentos, estoques e informações de equipamentos.
O GeneralData2 é uma versão aprimorada, que disponibiliza informações adicionais e uma comunicação mais flexível.
PrintHostsData
Permite consultar os NDD Print Hosts do provedor e gerenciar os endereços de rede cadastrados para o monitoramento de impressoras.
ServicesDeskData
Permite executar ações relacionadas a demandas e consultar informações do Portal de Serviços por meio da integração.
StockOrdersData
Permite consultar e executar ações em pedidos de transferência vinculados aos centros de distribuição.
SupplierOrdersData
Permite consultar e executar ações em pedidos de entrada relacionados aos fornecedores.
É possível receber notificações automáticas do MPS?
Sim. O MPS disponibiliza Web Services de notificação que podem ser implementados pelo provedor ou pelo cliente para receber informações automáticas sobre:
-
abertura, encerramento, comentários e alterações em eventos;
-
alterações no status de pedidos e entregas.
Para esse cenário, o Web Service do cliente deve ser publicado utilizando HTTPS e retornar ao MPS o resultado do processamento da chamada.
A integração permite apenas consultar dados?
Não. Além de consultar informações, a integração permite executar ações, como:
-
atualizar dados de impressoras;
-
manipular eventos;
-
importar informações;
-
gerenciar endereços de monitoramento;
-
tratar pedidos de suprimentos.
Os métodos que realizam alterações devem ser utilizados somente após a validação do fluxo de negócio e das permissões necessárias.
É possível utilizar os dados no Power BI?
Sim. Para isso, é necessário desenvolver um integrador ou processo de ETL que consuma os Web Services, trate os retornos e disponibilize os dados para o Power BI.
Os Web Services retornam os dados no formato JSON, o que facilita o tratamento por aplicações integradoras. No entanto, não há um conector nativo e automático do MPS para o Power BI.
Quais são os requisitos de acesso?
A integração exige:
-
credenciais válidas;
-
permissões compatíveis com o método utilizado;
-
acesso liberado aos Web Services para o provedor ou a empresa.
As senhas devem ser informadas de forma criptografada, conforme os exemplos disponibilizados no Integration Kit.
Quais cuidados devem ser adotados?
-
Utilizar somente os métodos necessários para o processo de integração.
-
Aplicar filtros para evitar consultas excessivas.
-
Proteger credenciais, chaves e dados retornados pela API.
-
Validar as permissões antes de executar métodos que realizam alterações.
-
Tratar os retornos de erro, incluindo falhas de autenticação, permissões insuficientes ou limite diário de acessos.
-
Publicar os Web Services de notificação utilizando HTTPS.
Onde consultar a documentação técnica?
A documentação completa, incluindo métodos disponíveis, parâmetros, exemplos, retornos e erros, está disponível no Integration Kit.