MatrixMaxx utilizes a standard protocol for SSO and has a robust API.
We have included recent versions of our SSO and API documentation here, for reference, but our SSO/API documentation is constantly being upgraded, so when you embark on a new integration, we will provide the latest documents to you at that time, as part of the integration fee.
Single SignOn (SSO)
- We assume that MatrixMaxx is the Database of Record (aka Database of Authority).
- MatrixMaxx by default supports two well-known SSO (Single Sign-On) protocols
- CAS (Central Authentication Server)
- Oauth2
- Our newer MatrixMaxx implementations are already running CAS and/or Oauth2 from day 1; some of our older implementations need to be upgraded to use it if they want to use these protocols to integrate with outside vendors.
- See MatrixMaxx SSO documentation (updated 12nov2021)
Application Programming Interface (API)
MatrixMaxx has two APIs available and in use.
- The original, low-level API allows access to any table in the database
- We grant server-to-server access to this API via IP whitelisting or token-based access
- Most existing integrations as of 2021 use this original API
- It is fast and easy to connect to and pull READ-ONLY data via this API.
- WRITE access to this API must be discussed/scoped on a per-project basis.
- These older endpoints will continue to exist for the foreseeable future
- See documentation: MatrixMaxx API documentations (updated 12n0v2021)
- The newer High Level (HL) API, introduced in 2021, is provides modern, more efficient calls for the most requested/popular data.
- OpenAPI compliant API documentation, generated in real time, so always up to date
- Routes are testable using the API documentation app
- Most routes have a few commonly used default fields (almost always ID and some sort of name) plus the ability to include only the fields you need, m
- Any custom API endpoints we create going forward for you will be added to your client-specific documentation
- Currently only GET requests (so getting/pulling info, not updating/writing data records)
- Note: Only new HL API endpoints are included in this new documentation.
- Link to the dynamic HL API documentation here.
Dynamic Style Wrapping (Scrape & Drape)
- The MatrixMaxx AMS system generates a variety of pages meant for use on the WWW website of the association. These pages are ‘ready to go’ and all the association needs to do is link to them. (There is no iframing, no API pulls needed to the CMS. These are usable website pages.) These pages include: Login page, Reset Password/Create Profile functionality, Manage profile, rosters, directories, calendar, registration forms, etc.
- Ideally, the user shouldn’t notice the difference between a CMS-generated website page and an AMS-generated website page, so the WWW website pages generated by the MatrixMaxx AMS are designed to be styled to match the rest of the CMS/Website pages by dynamically pulling the styles/headers/footers we need from the CMS.
For more information refer to the following documents Checklist for creating Maxx WWW headers and footers (updated 12nov2021) & CMS integration with Scrape and Drape (updated 12nov2021)