Skip to content
English
  • There are no suggestions because the search field is empty.

Internal - How to Grant API Access to a User

A guide for adding API access to a user via the Clients Page

Some clients use the MediRoutes API to get trips into their system, either because they have a website that clients can book private pay trips through or for some other reason. When a client is in the beginning phase of using the MediRoutes API, the first thing they will need is to have API access granted on their user account. This can only be done by a Tier 2 or higher Support team member through the Clients Page. 

Step 1: Navigate to Client's Employee List

First, login under your super admin MediRoutes account (if you are not already logged into it), and go to the Clients Page.

Type in the client's company name and hit enter on your keyboard. Once you see the company in the search results:

1. Click on the company name to expand the information and options for the company.

2. Click Client Options

3. Click Employees to get to the Employees List for that company.

Step 2: Locate and Edit the User

1. Locate the user account needing API access in the Employees List.

Tip: If it is a long employee list, use the search bar at the top to limit your results. 

2. Click the pencil all the way to the right of the user to pull up the edit window.

Step 3: Add API Mapping

In the user edit window, click the button that says API Mapping

1. The list on the left requires that you type in the company name to search and select only the company that the user account is listed under. For example, in this case, we are working out of Fictional Tucson Company, so that is the company name we will search and select.

2. The list on the left is to select the funding sources that the user needs API access to. Always ask the company or user requesting the access to confirm if they need access to all funding sources for the API or just some of them. 

Tip: clicking the Selected box at the top of the funding source list will automatically select all funding sources in the list. 

3. Click Confirm at the bottom of the window to save the access. (You may need to scroll down to get to it.)

After clicking Confirm, the API access will be saved to that user, and you can let the client or user know that the API access has been granted.