New API Partner – Go Live Checklist

Make sure the new API partner has completed the FareHarbor API Partner Survey! If not, send a reminder email. We need this information to make the announcement to the whole company and update internal and client-facing pages.

Create the API partner Dashboard

• Company Name: “Company name – USD”
• Company Shortname: “companynameusd”

Please see the list below with some of the supported countries, their respective currencies and how the new API partner company name and shortname should be created in the Dashboard. Use as an example for any currency that are not currently in the list.

Next:

• Generate production environment API keys – APP and USER Key
• Duplicate the Partner XYZ & FareHarbor – API Credentials Google Sheet. Rename the duplicate Google sheet to the new API Partner and add their currency credentials.
• External API Permission Group Updates – Compile a list of their current list of partners (FH clients in common) from their Affiliate Dashboard in a Google sheet, separated by currency. Make sure to Duplicate and rename this Google sheet with the New API Partner’s name.
• Create a new record in the API Partners Full Detail Overview table in SP Airtable.
  • In the field “Company Name” field – add the new API partner company name (you can take it from their Close lead.
  • Leave the field “Status” as blank and do not assign a status
  • Add a link to the Partner XYZ & FareHarbor – API Credentials Google Sheet you just created under the Currency Credentials field.
  • Add a link to the Partner’s XYZ – NEW Permission Update – Going Live! Google sheet in the NEW Permission Update – Going Live! field
• Once the new API partner has completed the survey, use the SP – API – Live API Credentials email template to send their API keys AND Current List of Partners spreadsheets.
• Add the API keys to the API Key Cheat Sheet here.

The next sections outline the steps to announce the new API connection internally. Please read and follow them carefully!

In the partner’s Close lead:

• Under the Dashboard Object:
  • Set SP – Affiliate Setup custom field to “API Partner”.
  • Set SP – API Partner Status custom field to “7 – Live”.
    • The custom field SP – API Partner Live Date will automatically appear when the SP – API Partner Status is set to “7 – Live. If it doesn’t, set a task for SP Ops.
  • Add the FH Shortname and FH URL custom fields.
• Under the URL Object:
  • Check if the SP – Company Type field is filled. If not, choose an option.

Initial Post

• Open the connectivity-extapi Slack channel and complete the New API Partner Handoff workflow.
• Once posted, the workflow will:
  • Tag SP Operations to update all relevant help pages.
  • Notify Connectivity Specialists that the partner is ready for a technical handoff.
• SP Operations will tag you in the thread once they have updated Internal help pages (e.g., API Changelog, API Partner Glossary) and client-facing pages (e.g., API Partner Directory help page, Connectivity Partners Compass page).
• After confirmation, you can announce the new API connection internally to other FH teams.Read here
• SP Ops will share the update in the #product-updates channel using this message:

SP Manager – Slack post to other FH teams

Post in the #strategicpartners-affiliates public Slack channel using the template message below. Keep the layout the same, but feel free to add relevant details.

• Tag the whole channel with @channel if it’s a brand partner (e.g. Klook, Ctrip) everyone needs to know about.
• For region-specific updates, tag regional AMs or Sales using these tags (more tags will be added soon):
  • Europe:
    • @europe_am – Europe
  • NORAM:
    • @needhamrippers – All Sales in Needham
    • @noram_am – NORAM
  • APAC:
    • @apac-am – Sydney
    • @apacrippers – Everyone in Sydney
    • @apac-salesrippers – AEs in Sydney