How to enable a MarketPlace Partner in your FastTrack360 platform

Great news! You have decided to boost your FastTrack360 system by adding a new MarketPlace partner. To help you stay ahead of the competition we want to get you and running as quickly as possible so have put together some simple steps below.

Let’s get started!

Steps:

  1. Sign up with the relevant partner - the first step is to ensure you have signed a contract with the relevant MarketPlace partner to use their services.

  2. Web API User - Next we need to enable an API Web User in your FastTrack360 system. This is where you give permission for the MarketPlace partner to access your FastTrack360 system through APIs.

  3. Custom Section/Custom Action Setup - Finally we setup the partner integration with a new Custom Section or Custom Action so you can access them from within you FastTrack360 system.

  4. Role Access - Then we need to either update an existing role or setup a dedicated role so you can give those you want access to the new MarketPlace partner.

Before we get started let’s explain the key parts:

  • Web API User - this is a user that you setup with FastTrack360 that allows a MarketPlace Partner to access your data. The key information the partner needs is the Web API User username and password to complete their integration. You have control over enabling/disabling this.

  • Web API Security Role - this is the permissions you give the Web API User on what data the partner can access, and what level of access they have (e.g. edit, add, view and candidates, clients, payroll etc)

  • API Key - this the unique key that allows the MarketPlace partner to access your environment. It’s a second security step for partners as they need both the Web API User username and password, plus the API key to access your environment. FastTrack controls this and shares this directly with the partner. We create one key per partner, per environment (e.g. UAT, Training and Production).

  • Custom Section - this is a window or iframe within FastTrack360 where MarketPlace partners can show their products. This helps you be able to use both systems without having to leave the FastTrack360 platform.

  • Custom Action - this is where you can trigger actions with MarketPlace partners within FastTrack360. This may or may not include a pop-up screen where you can manage what actions you are triggering - it depends on how each partner has built their integration. This allows you to trigger an onboarding or compliance check, for example, with a MarketPlace partner without having to leave the FastTrack360 platform.

Enabling a Web API User

  1. Enabling the Web API User

    1. Go to Maintenance>User in FastTrack360

    2. Select Web API User from the User Type drop down menu and click the blue Search button

    3. Search for the Web API User that matches the MarketPlace partner you are wanting to add (existing partners have been preconfigured in your system already)

    4. Click on the Web API User and click the blue Edit button on the top right

      1. Click the blue Reset Password button in the Login Details section. Set a secure password for this user. Save a copy of this password to supply to the MarketPlace partner together with the Web API Username (just above the Reset Password button)

      2. Click on the Terms & Conditions checkbox in the Login Details section to confirm you are comfortable with allowing the Web API User/MarketPlace access to your system

      3. Go to the Security and Permission section and click the blue Add button to include a Security Role (a security role has been pre-configured for each partner in your environment, so just find the right one for the partner you are adding)

      4. Select the Security Role relevent for the MarketPlace partner you are adding and the relevant data group (commonly the default data group) and click the blue Save button

      5. Lastly, and most importantly, click on the Active checkbox at the top of the Web API User screen

      6. Click the blue Save Changes button

Getting the client specific URL

Before you complete the next step you will need to get your specific URL for the Custom Section and/or Custom Action. To do this please share the following information with the relevant contact at the MarketPlace partner.

  • Web API User username

  • Web API User password (please send in a seperate email using http://privnote.com for security reasons)

  • X-Consumer-Name (this is the part of the clients URL highlighted in yellow - e.g. https://youragencyname.fasttrack360.com.au/RecruitmentManager/index)

  • API Key - this needs to be organised by your FastTrack360 Account Manager with the MarketPlace partner

Once supplied, the MarketPlace partner will be able to supply the client specific URL that is added to the Custom Section and/or Custom Action in the steps below.

Setting up a new Custom Section and/or Custom Action

  1. Please go to Maintenance

    1. If you can’t see Custom Sections or Custom Actions, you will need to set this up. Go to Maintenance > Security and select your role (see below if you are unsure of which role you have). Click Edit in the top right-hand corner then go to the ‘Maintenance’ section and find ‘Custom Sections’ and click on the tick box and click ‘Save’.

    2. If you are unsure of your role go to Maintenance > Users. Search for yourself (using username or surname for example) to find what ‘Security Role’ you have in FastTrack360

  2. Enabling a Custom Section

    1. Please go to Maintenance>Custom Sections

    2. Find the Custom Section for the MarketPlace partner you are looking to integrate and click on it (these are already pre-configured in your FastTrack360 platform)

    3. Click on the blue Edit button

    4. Update the URL with your specific URL as provided by the partner

    5. Select the Active checkbox and then click the blue Save button

  3. Enabling a Custom Action

    1. Please go to Maintenance>Custom Actions

    2. Find the Custom Action for the MarketPlace partner you are looking to integrate and click on it (these are already pre-configured in your FastTrack360 platform)

    3. Click on the blue Edit button

    4. Update the URL with your specific URL as provided by the partner

    5. Select the Active checkbox and then click the blue Save button

Setting up access to the Custom Section and/or Custom Action for the appropriate staff (aka agency users) in your environment

  1. Go to the Maintenance > Security in FastTrack360.

  2. You can either update an existing Security Role or create a New Security Role

    1. To update, select the Role you wish to update, select Edit.

    2. Select the new Custom Section you have just setup and tick the box. (Tip: press Ctrl+F if using Google Chrome and search for ‘Custom Section’ or ‘Custom Action’ to find the one you have just added)

    3. Once complete please click Save.

  3. To create a New Security Role, you have two options:

    1. Duplicate an existing role & add access

      1. Firstly, select the Security Role you wish to duplicate, click on it and select ‘Copy’ from the top right

      2. Name the role (e.g. MarketPlace Partner Name access) and ensure you tick the Custom Section box you created earlier

      3. Once complete please click Save

    2. Create a brand-new security role

      1. Click Add.

      2. Select User Type Agency User and name the role as you wish (e.g. MarketPlace Partner Name Access)

      3. Select the new Custom Section you have just setup and tick.

      4. Once complete please click Save

    3. Find the Users you want to provide access by searching under Maintenance>User.

    4. Please click on specific users and under Security and Permissions section for that user select Add.

  4. Select the new Security Role you have just created/updated.

  5. Select the appropriate Data Group for your business.

  6. Once complete please click Save.

That’s it! You have now given the new MarketPlace partner access to your system via APIs for a seamless integration, created the custom section and/or Custom Action so you can access the partner within the records you want and provided access to users you wish.

We hope this process was straight forward and helps you do more than ever before with your FastTrack360 system.

If you need any assistance with this process please easily log a ticket via the FastTrack Customer Support Help Desk here.