Creating a test environment

Things to note when creating a new affiliate:

• Always make sure the timezone, processor country, and processor currency align with the affiliate the test environment is for.
• Ensure that “Test Environment” is in the name of the affiliate Dashboard so that no other FareHarbor employees will use this Dashboard for demo purposes.
• All of the arrows above reference what is needed when creating a new dashboard.

The Strategic Partnerships Team has a set of charter Demo Dashboards specifically created and used for API testing. Whenever you are creating a new test environment for an API Partner, always make sure the timezone, processor country, and processor currency align with the affiliate the test environment is for (charter & affiliate). To view a complete Airtable list of client Dashboards available in different currencies click here.

The affiliate may be added to one of the charters above, depending on what currency the affiliate Dashboard has. As we build out additional Dashboards, this list will grow and help with different testing scenarios.

To add an affiliate to a charter Dashboard:

1. Go to Settings > Affiliates > Add affiliate.
2. Add your affiliate company.
3. Choose a Price sheet (the default Price sheet is Online).
4. Select an Invoice sheet, if desired.
5. Choose Default – API for the Cancellation policy.
6. Navigate to Permissions: Affiliate > API External.
7. Payment Default: Affiliate taking payment, uncheck voucher field.
8. Add affiliate.

1. Go to the Affiliate’s Dashboard > Settings > Users & Permissions.

2. Select New User. There is a new requirement now for every new Dashboard user to enter an email. It will be a unique email each time with the template email being: api-support+(partnername)+(currency)@fareharbor.com. For example: api-support+manawa+mxn@fareharbor.com

   

3. After you complete the above, select Next and complete the information below.

   

4. Click the API Keys tab.

5. Click Add API Key.
6. Name the key API and click Create.

7. You now have your API User Key.

8. Next, generate the App Key.

   1. Go to the Admin Dashboard.
   2. Go to Settings > Integrations > Add Channel App.

   3. Name your Channel App the name of the affiliate, then click Create.

      You now have your API App Key.

   

9. Now we need to link the App key to the user key.

   1. In the channel app page, click on Edit next to your new channel app.
   2. Click Add Company.
   3. The affiliate should get tagged, then click Create.

   4. This has linked your App Key to your User Key.

      Note: An App Key can have multiple User Keys linked.

Now that you have completed the previous steps, you should already have:

• App Key (step 3)
• User Key (step 3)

Next, email your POC at the partner company using email template SP – API – Sending Quickstart Guide to send them their testing keys and a link to the API Partner Help Center.

Create a new record in the SP Airtable All API Partners – SP – Managers Only and fill out all the information in the columns.