Overview
To authenticate with ModMed, you will need:- Environment - The environment you’re connecting to (sandbox or production)
- Firm URL Prefix - The firm URL prefix for your practice
- Username - Your ModMed API username
- Password - Your ModMed API password
- API Key - Your ModMed API key
Prerequisites:
- You must have a ModMed account with API access.
Instructions:
Step 1: Request access to ModMed sandbox
- Request access to the ModMed sandbox by visiting https://www.modmed.com/become-a-partner/ and submitting the partner request form.
- Once approved, ModMed will provide you with:
- Username: Your ModMed API username
- Password: Your ModMed API password
- API Key: Your ModMed API key
To use a production key, you must complete a review process with ModMed. Once the demo and technical discussion are successfully completed and your desired resources are provisioned, you will receive a production key and instructions on how to take practices live with your application. For more details, see the ModMed documentation on requesting resources.
Step 2: Finding your Firm URL Prefix
The Firm URL Prefix is the practice’s unique identifier for the specific firm (practice) you’ll be working with.Step 3: Selecting your Environment
Choose the appropriate environment based on your needs. Use the following table to select the correct environment value:| Environment Name | Value |
|---|---|
| Generic Sandboxes | stage.ema-api.com/ema-dev |
| Practice Sandboxes | stage.ema-api.com/ema-training |
| Production | mmapi.ema-api.com/ema-prod |
Step 4: Enter credentials in the Connect UI
Once you have your ModMed credentials:- Open the form where you need to authenticate with ModMed.
- Enter your Environment, Firm URL Prefix, Username, Password, and API Key in their designated fields.
- Submit the form, and you should be successfully authenticated.
