MRI API Integrations Guide - How to integrate RESTful APIs

Nov 2, 2026

Uploaded by Mia

MRI API Integrations Guide describes how to call MRI RESTful APIs using a shared URL for read/write operations. It covers required authentication via the Authorization header, forming minimal HTTP GET requests, and referencing API invocation URLs built from the MRI web domain and API name. The guide explains core API usage topics including authorization, reading entries, paging, discovering structure, shaping responses, creating and merging entries, error reporting, troubleshooting, and support case recommendations with practical examples and attachment handling.

LanguageEnglish

CategoryTechnology

FormatPDF

Pages14

Reading Time35 min

AccessFree to download

Calling RESTful APIs Created with APIDesign

Authorization

Reading Entries

Paging

Discovering the Structure of the API

Shaping Responses

Creating New Entries

Merging with Existing Entries

Error Reporting

Troubleshooting

HTTP Status Codes

Support Case Recommendations

Example

Support Case

Attachment

MRI API Integrations Guide ©2018 MRI Software, LLC. Any unauthorized use or reproduction of this documentation is strictly prohibited. All rights reserved. iMPACT!, ForeSight, LeaseFlow, ViewPoint, Access 24/7, JobCost, Prospect Connect, Resident Connect, Tenant Connect, CallMaX, Plato, Enterprise Ledger, Commercial Tenant Portal, Cougar, ShaRE, CRE Manager, Market Connect, Management Reports, Inc., MRI Management Reports International, and MRI are trademarks of MRI Software LLC. Workspeed Notify is powered by MIR3 . This list is not a comprehensive list of all MRI trademarks. The absence of a product name, logo, or slogan from this list does not constitute a waiver of MRI's trademark or other intellectual property rights concerning that product name, logo, or slogan. The following are either registered trademarks or trademarks of their owning companies in the United States and/or other countries: Microsoft, Windows, Internet Explorer, Microsoft Edge, SQL Server, Excel, Word, Active Directory Federation Services, Active Directory, Azure, Visual FoxPro: Microsoft Corporation; Adobe, Acrobat, Acrobat Reader, Adobe PDF: Adobe Systems, Inc.; Android, Chrome, Google Analytics: Google, Inc.; Firefox: Mozilla Foundation; iPhone, iPod, Mac, Safari: Apple, Inc.; Aptexx: Aptexx, Inc.; AvidXchange: AvidXchange, Inc.; Blue Moon Software: Blue Moon Software, Inc.; C•CURE: Tyco International Ltd. and its respective companies; CBC: CBC Credit Services, Inc.; Citrix: Citrix Systems, Inc.; ClickPay: NovelPay LLC; CORT: CORT; craigslist: craigslist, Inc.; CreditRetriever: TransUnion, LLC; dBase: dBase, LLC; DocuSign: DocuSign, Inc.; Elasticsearch: Elasticsearch BV; EVO Snap: EVO Payments International, LLC; First Advantage, LexisNexis, Resident Data: First Advantage Corporation; HappyCo: Happy Inspector, Inc.; IDAutomation: [IDAutomation.com](IDAutomation.com), Inc.; Jenark, SafeRent: CoreLogic, Inc.; LRO: Rainmaker Group Real Estate, LLC; NACHA – The Electronic Payments Association: National Automated Clearing House Association; MagTek, MICRImage: MagTek, Inc.; NWP: NWP Services Corporation; OANDA: OANDA Corporation; Okta: Okta, Inc.; Panini, Vision X: Panini SpA; PayLease: PayLease, LLC; ProfitStars: Jack Henry & Associates, Inc.; RentTrack: RentTrack, LLC; Quickbooks, Quicken: Intuit, Inc.; RentPayment: YapStone, Inc.; Salesforce: [salesforce.com](salesforce.com), Inc.; Tableau: Tableau Software; TransFirst: Transfirst Holdings, Inc.; WinZip: WinZip International, LLC; Yardi Resident Screening: Yardi Systems; YieldStar: RealPage, Inc. All rights reserved to the respective owners. Every released version of MRI products gets its own release notes. However, guides are only updated when changes have been made to product features that require changes to documentation. If there is no guide specific to your version, use the most recent corresponding document (which may refer to an earlier version of the software) . Table of Contents Calling RESTful APIs Created with APIDesign ..............................................................4 Authorization .....................................................................................................................4 Reading Entries .................................................................................................................5 Paging ........................................................................................................................5 Discovering the Structure of the API ...............................................................................5 Shaping Responses ..........................................................................................................6 Creating New Entries ........................................................................................................7 Merging with Existing Entries...........................................................................................8 Err

FAQs

What authentication method do MRI RESTful APIs require?

Every API call requires credentials provided in the Authorization header. The guide points readers to the “Authorization” section for the required details.

How do you form an HTTP request to invoke an MRI API?

The request URL is constructed using the MRI web domain and the API name. The guide provides an example using the GET method to read data from an endpoint like vendors.

What should you do when API calls fail or return errors?

Use the guide’s Error Reporting and Troubleshooting sections to interpret failures and resolve issues. It also includes a section on HTTP Status Codes and recommendations for filing a support case.

Nov 2, 2026

Uploaded by Mia