Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 2.59 KB

theexchange-gettingstarted.md

File metadata and controls

31 lines (22 loc) · 2.59 KB

The Exchange® by Fannie Mae

Getting Started Guide

Registration

  1. Browse to theexchange.fanniemae.com.
  2. Click “Sign Up”. Create account and fill in your details.
  • You will receive an email with subject line: “The Exchange Account Confirmation”.
  1. Click on the link under the “Register Account” section within the email.
  • If the link does not work, we provide an url that can be copy and pasted into your browser.
  1. Login using the email address you used to register and the password you created.

Site Navigation

The site contains several key pages to help you learn about and interact with The Exchange.

  • Home — provides an overview of The Exchange as well as a link to sign up, navigate to the APIs and associated Documentation.
  • APIs — provides links to primary products – with Overview, Documentation, and Data Visualization (when applicable). The Overview Page contains information on the specifics of the data with data dictionaries. The Documentation Page displays the associated endpoints for an API product. The Data Visualization Page provides a sample data visualization.
  • Apps — our self-service data visualization tool for quick analysis and insights. Note that our tool is not supported on iOS and Android devices.
  • Documentation — provides information on API operations and the ability to interact with the API through the Swagger overlay.
  • Resources — The Exchange GitHub repository featuring code samples.
  • Account Profile — access your User Token, update account details and change your password.

Documentation and API Usage

  1. Register or log in and navigate to Documentation and click on one of the primary API endpoints.
  2. Copy and paste the curl command as a guide on how to begin programmatically with the API. This contains your User Token. If you remain logged into the site, your user token will be automatically refreshed. Please note that the User Token is set to expire after 60 minutes of inactivity.

Have a question or want to give us feedback? Contact us: [email protected]

© 2019 Fannie Mae. The Exchange is a registered trademark of Fannie Mae.