Skip to main content
The Xerox Managed Print Services (MPS) integration uses the Xerox MPS API V2. Workflows can look up printer assets, supply levels, meter reads, service tickets, supply orders, locations, contacts and users, and can create or update tickets and other records your MPS user is allowed to change.

Before you start

Xerox provides MPS API access through the Xerox Developer Program. After you accept the program agreement, Xerox sends:
  • An MPS API username and password.
  • An API key.
  • The account ID of each MPS account the user can reach.
  • The MPS API Developer Reference Guide, which gives the REST base URI.
Use a dedicated API user for Serval. Every MPS API call signs in as that user, and Xerox locks a user for four hours after four failed sign-ins.

Connect the integration

1

Find the REST base URL

In the developer guide, copy the REST base URI followed by /REST. Production URLs start with https://office.services.xerox.com/MPSAPIV2/; Xerox’s test environment uses https://uat.services.xerox.com/MPSAPIV2/.
2

Connect in Serval

Open Integrations > All integrations, select Xerox Managed Print Services, and enter the REST base URL, Account ID, Username, Password and API key. Save the connection.
Serval stores the password and API key as secrets. It sends the username and password as request headers and adds the API key to each request body, so workflow code never handles them. Serval only sends these credentials to office.services.xerox.com and uat.services.xerox.com, and only to the host and REST path saved in the connection. Each connection is one MPS account in one Xerox environment. To use another account or switch between production and UAT, add another connection. Changing the username requires entering the password again.

Verify the connection

Serval checks the connection by calling ValidateUser once. Every MPS API call signs in, so the check is limited to one call per run. When Xerox reports that it rejected the credentials or locked the user, Serval stops sending those credentials for four hours, the length of a Xerox lockout, so retries and scheduled checks don’t keep the user locked. Each Serval proxy instance keeps its own hold, so a few more failed sign-ins can still reach Xerox before every instance has seen one. Saving a new password or API key clears this immediately. If the user is already locked, reset the password in Xerox Services Manager and then update the connection.

Send requests

Call xeroxMps.apiRequest with method: "post", a path that is one MPS method name, such as /TicketGetList, and that method’s request object as the body. Serval adds APIKey, and AccountID unless the body sets another account the user can access. …Save methods carry both in their SaveOptions object, which Serval creates if you leave it out.
  • …GetList methods take a search request: PageNumber, PageSize, SortField, SortDirection (0 ascending, 1 descending) and Filters.
  • …Get methods return full records for the IDs you pass.
  • …Save methods create or update up to 100 records per call.
Xerox applies an hourly call limit per user. Page through large lists rather than requesting them in parallel. See the MPS API method reference.