How to obtain and configure your MRI Software integration key

This guide is for you, the Apideck customer building an integration. It covers obtaining a MIX Partner Key from MRI Software, choosing the right key tier, and where to enter the key in your Apideck integration settings.

MRI Software does not use OAuth: there is no app to register and no consent screen. Every MRI API call is authenticated with HTTP Basic credentials whose user name embeds a MIX Partner Key — a key MRI issues to you, the integration builder, under an agreement with MRI.

You configure that key once, at integration level, and it applies to every consumer connection on the connector. Your consumers never see it: they supply only their own MRI installation credentials (see the connection guide).

Before you start

An established relationship with MRI Software. There is no self-service developer portal for this key: MRI issues it under an agreement, and it evaluates integration providers case by case. Two routes exist — MRI's Partner Connect program (the Solution Partner category covers product and API integrations), or a customer-led introduction, where an existing MRI client sponsors your integration. An NDA may be required before MRI shares API access or documentation.
An Apideck account with the MRI Software connector enabled.

1. Get an MRI agreement in place

If an existing MRI client is sponsoring your integration, start with them — a customer-led introduction can route you to the right MRI contact directly, and their installation is in practice the environment you will build and test against.

Otherwise apply to Partner Connect, which runs in five stages:

Submit the application form. Start at Become an MRI partner and apply under the Solution Partner category.
Intro call. MRI's Partner Connect team schedules an introductory call, typically within 5–7 business days of your application.
Sign an NDA if MRI asks for one. MRI may require an NDA before sharing API documentation, sample APIs and partner materials. This gate is not publicly documented, so confirm what it covers with your MRI contact rather than assuming — plan for it, but do not treat it as certain.
Agree economic terms and execute the agreement. MRI presents commercial terms and then issues the contract. MIX API licensing may carry a fee.
Get provisioned. On execution MRI grants access to the myMRI Partner Portal and issues your MIX Partner Key.

Do not plan on an MRI-provided sandbox. MRI does not offer a general-purpose sandbox to middleware and integration providers. Asked directly in February 2025, MRI told Apideck the only available route was an existing customer's sandbox environment, and described access for middleware providers as an open question rather than a settled policy. Line up a sponsoring client with a test installation, or expect to build against a live one — and raise sandbox access explicitly with MRI early rather than assuming onboarding includes it, since the position may have moved since.

If you already hold an agreement with MRI, sign in to the myMRI Partner Portal and ask your MRI contact for the MIX Partner Key rather than re-applying.

2. Choose your key tier

MRI issues MIX keys in two tiers, and the choice materially changes what your integration can do.

	Partner key	Developer key
Which APIs it can execute	Only APIs already registered in MRI's MIX manifest	Ad-hoc / unregistered APIs as well
API structure caching	Cached for 24 hours	Never cached — reloaded on every call
Request rate	Higher	Lower
Best suited to	Running a production integration against MRI's registered APIs	Building and prototyping custom APIs

The Apideck MRI Software connector calls named, MRI-registered MIX APIs (for example MRI_S-PMAP_Departments and MRI_S-PMGL_Accounts), so a Partner key is the correct tier for production. Ask for a Developer key only if you also need to execute custom APIs you are still developing.

Whichever tier you take, MRI authorizes a key per client and per API. When you request the key, give MRI the full list of MRI APIs this connector calls — it is tabulated in step 1 of the connection guide — and ask for the key to be authorized for all of them, for each MRI client you expect to onboard. A key that is not authorized for a given API returns 401 on every call to it.

Because a Partner key caches the API structure for 24 hours, an API MRI has just authorized can keep failing for up to a day before it starts working.

3. Enter the key in your Apideck integration settings

Open the MRI Software connector settings in the Apideck Dashboard. Under the MRI Software Credentials section, fill in:

Field	Value
MIX Partner Key	The key MRI issued to you under your Partner Connect contract.

Click Save settings. The key is stored encrypted and is masked once saved, so keep your own copy in your secret manager.

This is the only credential you configure. Everything else — installation domain, client ID, application database name, Web Services user name and password — is supplied per connection by each consumer.

4. Onboard your consumers

Each consumer must, in their own MRI installation:

Create a Web Services class granting rights to every MRI API this connector calls.
Add a Web Services user and assign that class to it, using MRI Security Console.
Supply their installation domain, client ID, application database name, Web Services user name and password in Vault.

Point them at the connection guide for the full walkthrough. Note that Apideck validates a new connection by calling the departments list API (MRI_S-PMAP_Departments), so a connection cannot become valid until that API is licensed for the installation, authorized for your key, and permitted for the consumer's Web Services user.

Troubleshooting

Every connection fails with 401, even ones you believe are configured correctly. Confirm the MIX Partner Key was pasted without leading or trailing whitespace, then confirm with MRI that the key is authorized for that consumer's MRI client. Authorization is per client — a key that works for one consumer is not automatically valid for the next.

One specific resource returns 401 while others work. The key is not authorized for that particular MRI API. Send MRI the exact API name (for example MRI_S-PMAP_InvoiceDataV2) and ask for it to be added.

An API MRI just authorized still returns 401. Partner keys cache the API structure for 24 hours. Wait out the cache window before escalating.

You cannot find MRI's API documentation. Public documentation is minimal and dated — the main openly available reference is MRI's API Design Guide from 2016. Current specifics come through your MRI relationship, so request them from your MRI contact or via the myMRI Partner Portal, and expect an NDA to gate some of it.

For anything on the Apideck side of the connection, contact Apideck Support.

Reference

MRI Partner Connect program — program overview and partner categories
Become an MRI partner — application form
MRI Information eXchange (MIX) — the API ecosystem the key unlocks
MRI API Integrations Guide (PDF) — Basic authentication and the composite user name
MRI API Design Guide (PDF) — Partner vs Developer key behaviour