Overview

The MX SSO API is a RESTful API that's used to authenticate users on the MX Platform. There are SSO API endpoints to obtain a URL for an MX widget, including those for our Personal Finance Management and Financial Insights widgets, and to obtain an api_token to open a Nexus API session.

The SSO API supports both XML and JSON encoding of the request and response bodies.

Always use the get configurable widget URL endpoint rather than the list urls endpoint in testing and production. This is because as the latter endpoint has been deprecated.

MX will continue to support the use of list urls for existing integrations; however, using this endpoint presents several undesirable factors. First, it significantly impacts the API response time due to the fact that the MX system needs to generate a url for all widgets before sending a response. In addition, you are required to parse the API response to extract the url(s) they want. This increases the complexity of the implementation code and requires additional application resources. Finally, MX will not maintain which widgets are available through this endpoint, which means any new widgets will not be returned in the response.

In contrast, if you use the get configurable widget URL endpoint receive an API response much quicker, and can rely on the response to always contain the url field regardless of which widget was specified in the API request.