What is NDD Print MPS API integration?
API integration allows you to connect external systems to NDD Print MPS through the Web Services provided in the Integration Kit.
With it, you can retrieve information and automate actions related to contracts, meters, equipment, events, supplies, stock, orders, and NDD Print Host.
What are the main benefits of integration?
Integration allows you to:
-
automate operational activities that previously required manual queries and actions on the portal;
-
centralize MPS data in your own systems, such as ERP, BI, CRM, or internal portals;
-
support processes for contract management, billing, supply logistics, and event tracking;
-
create integrated workflows for demands, orders, stock, and service calls;
-
receive automatic notifications about events and changes to orders.
What information can be accessed?
Depending on the Web Service used, you can access information such as:
-
contracts, closings, and consolidated values;
-
printers' meters;
-
printers' events and system events;
-
companies, sites, departments, printers, manufacturers, and models;
-
supplies, stock, distribution centers, and suppliers;
-
transfer orders and supplier orders;
-
NDD Print Hosts and printers registered for network monitoring.
Which Web Services are available?
ContractsData
Allows you to view and manage information on contracts, associated printers, contract closings, consolidated values, and the status of equipment under or out of contract.
CountersData
Allows you to view counter types, simple meters, and reference meters, as well as add meters when applicable to the integration flow.
EventsData
Allows you to view printer and system events, as well as perform actions such as opening, closing, reopening, ignoring, commenting on, or waiting for events to be resolved.
GeneralData and GeneralData2
These allow you to view and manage general environment data, including companies, printers, sites, departments, materials, supplies, stock, and equipment information.
GeneralData2 is an enhanced version that provides additional information and more flexible communication.
PrintHostsData
Allows you to view the provider’s NDD Print Hosts and manage the network addresses registered for printer monitoring.
ServicesDeskData
Allows you to perform actions related to service requests and view information from the Service Portal through integration.
StockOrdersData
Allows you to view and perform actions on transfer orders linked to distribution centers.
SupplierOrdersData
Allows you to query and perform actions on incoming orders related to suppliers.
Is it possible to receive automatic notifications from MPS?
Yes. MPS provides notification Web Services that can be implemented by the provider or the customer to receive automatic information about:
-
the opening, closing, comments, and changes to events;
-
changes in the status of orders and deliveries.
For this scenario, the client’s Web Service must be published using HTTPS and return the result of the call’s processing to MPS.
Does the integration only allow you to query data?
No. In addition to querying information, the integration allows you to perform actions such as:
-
updating printer data;
-
manipulating events;
-
importing information;
-
managing tracking addresses;
-
processing supply orders.
Methods that make changes should only be used after validating the business workflow and the necessary permissions.
Is it possible to use the data in Power BI?
Yes. To do so, you must develop an integrator or ETL process that consumes the Web Services, processes the responses, and makes the data available to Power BI.
The Web Services return data in JSON format, which facilitates processing by integration applications. However, there is no native, automatic connector from MPS to Power BI.
What are the access requirements?
Integration requires:
-
valid credentials;
-
permissions compatible with the method used;
-
authorized access to the Web Services for the provider or company.
Passwords must be provided in encrypted form, as shown in the examples provided in the Integration Kit.
What precautions should be taken?
-
Use only the methods necessary for the integration process.
-
Apply filters to avoid excessive queries.
-
Protect credentials, keys, and data returned by the API.
-
Validate permissions before executing methods that make changes.
-
Process error responses, including authentication failures, insufficient permissions, or daily access limits.
-
Publish notification Web Services using HTTPS.
Where can I find the technical documentation?
The complete documentation, including available methods, parameters, examples, responses, and errors, is available at the Integration Kit.