/
Setting up an export of contact data using VIA's API

Setting up an export of contact data using VIA's API

You can now provide any portal or third party access to your contact data. This will enable you to integrate your contact data with a host of third parties.

Your data will be made available through an XML pull that can be requested up to 49 times a day. Please note, there will an additional monthly charge for any active exports you setup.

You must have an SSL secure website in order to transfer your contact data. If you do not have SSL security installed, you will not be able to transfer data

Step 1 - Making your data available. Please note: Only Super User are able to generate an API Key

  • Log in to VIA

  • Click the top tab labelled CRM or Lead Manager

  • Click the Contacts tab

  • You can now search for the criteria of contacts that you want to make available through the VIA API. Click the Advanced button to reveal the full list of criteria you can select. These include:

    • Office (contacts allocated to specific offices)

    • Owner (contacts allocated to specific members of staff)

    • Set to (applicant, vendor etc)

    • Status (active or archived)

    • Enquiry From (Google, Rightmove, etc)

    • Events & Date Ranges (Choose from events such as registered or last contacted and the specific time frames of when those events occurred. This can either be dynamic, eg: last 30 days or between specific date ranges)

This enables you to completely customise what contacts you would like to make available in your export.

  • Once you have selected your criteria, click Search. If you want to make all of your contacts available, simply click Search

  • Click the API Key button in the top right hand side of the page

  • A pop up will appear asking you to name your API Key. Please ensure you label your API Key so that it is easily recognisable in future, in case you need to disable or delete it in future

  • Go to the left hand menu and select Settings > API Access

  • A list of the API Keys you have generated will be listed, as well as key information about them

  • Click the URL section of API Key you want to send to your third party. This will automatically copy your API Key. You can now paste this into an email to send it to your third party. IMPORTANT: Please ensure you only make your API Key available to the specific party that has requested it. You should not make your API Key public or publish it anywhere on your website

 

Step 2 - Instructions for your third party

  • The contact data will be made available through a URL, allowing you to pull XML data up to 49 times in 24 hours