Adding a new currency Dashboard for an API partner
Last updated: August 13, 2025
Every time an API partner begins working with a supplier on a new currency, a new affiliate Dashboard needs to be created as well as a new Close lead. Same for any new OTAs that begin working with a Channel Manager to connect to FareHarbor suppliers. The steps below outline the process of adding a new currency Dashboard for an External and Channel API partner.
External API Process
If you’re completing a request to connect a new OTA to a Channel Manager please check with Strategic Partnerships to ensure that OTA has paid the new onboarding fee. This is the OTAs responsibility rather than the Channel Manager.
Use the New OTA Request for a Channel Manager workflow in the #connectivity-extapi channel and advise the client that we will follow up once the partner has been onboarded. Strategic Partnerships will submit a ticket to Connectivity once the fee is paid.
Note: The fee does not apply to OTAs that are already connected through a Channel Manager but are requesting new currency keys.
Adding a New Currency Dashboard
Adding a new currency Dashboard for an External API Partner should only be completed by the @connectivity_team. If you need a new currency Dashboard created for a live External API Partner, please slack your request to @connectivity_team in #connectivity. To see a list of all Live API Partners, click here.
Below is the checklist that the Connectivity Team (steps 1-7) and Partnerships Team (steps 8-10) will follow when adding a new currency-affiliate Dashboard for an External API Partner. Please follow the steps carefully.
1. Create a new company in the FareHarbor Admin dashboard. Make sure to include “API” at the end of the company name. This allows clients to easily tell which of their affiliates are API partners in the dashboard.
- Company Name: “Company name – USD – API”
- Company Shortname: “companynameusd”
- Processor Country: must use the currency that we’re enabling for API access
- Company Type: de-select Charter Company and select Affiliate Company
- De-select Demo Mode
- Save
Please reference the list below with supported countries, their respective currencies and how the new API partner company name and shortname should be created in the Dashboard.
| Country | Currency | Dashboard Company name | Shortname |
|---|---|---|---|
| Australia | AUD | Company name – AUD | companynameaud |
| Bulgaria | BGN | Company name – BGN | companynamebgn |
| Canada | CAD | Company name – CAD | companynamecad |
| Czech Republic | CZK | Company name – CZK | companynameczk |
| Denmark | DKK | Company name – DKK | companynamedkk |
| Euro area | EUR | Company name – EUR | companynameeur |
| Hong Kong | HKD | Company name – HKD | companynamehkd |
| Mexico | MXN | Company name – MXN | companynamemxn |
| New Zealand | NZD | Company name – NZD | companynamenzd |
| Norway | NOK | Company name – NOK | companynamenok |
| Poland | PLN | Company name – PLN | companynamepln |
| Romania | RON | Company name – RON | companynameron |
| Singapore | SGD | Company name – SGD | companynamesgd |
| Sweden | SEK | Company name – SEK | companynamesek |
| Switzerland | CHF | Company name – CHF | companynamechf |
| United Kingdom | GBP | Company name – GBP | companynamegbp |
| USA (and Puerto Rico) | USD | Company name – USD | companynameusd |
| Thailand | THB | Company name – THB | companynamehuf |
| United Arab Emirates | AED | Company name – AED | companynameaed |
| Hungary | HUF | Company name – HUF | companynamehuf |
| South Africa | ZAR | Company name – ZAR | companynamezar |
Note: For partners using a Channel Manager to connect to the FareHarbor system, please include the name of the Channel Manager at the end of the company shortname.
Important: Some API Partners still use Dashboards to view bookings, items, availabilities, and/or make bookings. When a new Currency Dashboard is created check the main dashboard and, if needed, add any outside user/s that are in the original Dashboard. Refer to the Outside Users admin notes help page to review steps. This allows for a user to have one login and easily switch between different Dashboards by selecting the Dashboard they want to view via the company drop-down on the top-right of the screen.
2. Once added, create a new user on the affiliate Dashboard.
- Name: Company name API
- Username: api
- Email: api-support+(OTA name+currency)@fareharbor.com. Example
- Password Setup –> set temporary password –> generate password
- Select Director level permissions
- Select Partner Group permissions
3. Within the new user, create a new API key
- Name: API
4. Once API Key is created, link the App Key & User Key
- Go to FareHarbor Admin Dashboard –> Settings –> Integrations
- Search by company or Channel Manager name to find their Channel App key –> Click “edit”
- Add company –> add the new affiliate Dashboard to pair the user key to the channel app key
5. Add the new user key to the API Key Cheat Sheet (Google)
- Add the new user key in the API Key Cheat Sheet
6. Send the new keys to API Partner
- Connectivity Specialist should use “New API Key” macro in Zendesk and send to the primary API contact in Close.
- Add new keys to the partner’s API Credentials doc and include that in your message. Google Sheets can be found here in the Strategic Partnerships AT under the Currency Credentials column. If one does not exist, you can copy the template and add all relevant currency credentials + link in the partner’s AT record. Sharing permissions should be restricted to FH employees and only shared with designated API contact emails.
7. Inform Strategic Partnerships Team
- Connectivity Specialist sets a task in Close for the Strategic Partnerships Owner listed in SP – API Partner Owner custom field.
- Task should say: API Partner has been provided API Keys for Currency XYZ. Please add a new Dashboard Object to this lead and update the API Partner – Glossary Airtable view.
- If the OTA is working with a Channel Manager, post in the #strategicpartners-affiliates channel using the Partner Info Updates workflow to inform the SP Operations team that the OTA is connecting through a Channel Manager (include the name of that Channel Manager). Flag that updates are needed for Close and AT.
Notes: If the request for the new Dashboard originated internally (ex. from a Channel Specialist or an Onboarder) the Connectivity Specialist should also post in #connectivity to let that original requester know that the affiliate Dashboard has been created and affiliate has been added.
8. SP Team: Add a new Dashboard object to partner’s Close lead
- Create a new Dashboard object in the partner’s Close lead and add this info:
- Name of the new Dashboard Object should be partner’s shortname
- FH URL should be the link to their Dashboard
- FH shortname
9. SP Team: Update API Partner Glossary
- If the new key means the partner changes geographic category (ex. from EMEA to Global), please update API Partner Glossary View in the SP Airtable.
10. SP Team: Reach out to the API partner to discuss new opportunities
- SP Manager may choose to reach out to their partnership contact to discuss any new opportunities for collaboration for the newly enabled country/currency.
Channel API Process
- Create the new affiliate Dashboards based on their ISO 4217 currency code (viatoreuro etc.).
- Create the API user with the EXACT name and permissions as the USD Dashboard.
- Add user name and login to this doc.
- Someone from the Product Team will reach out to the Connectivity Team asking for the doc above.
- To trigger connect, add the new Dashboard here. Temporarily Disabled.
- Submit this CD new lead form per Dashboard.