Custom Integration Documentation
ViaAds Custom Integration
Integrating the ViaAds advertising platform into your existing platform is a simple process, made easy through the use of our REST API and your personalized Product Feed. To facilitate the process, we've compiled a step-by-step guide to walk you through each stage.
Pre-requisites:
Before starting the integration, you will need to secure an API key from the ViaAds support team. This key will be crucial for authentication when you implement the API into your platform.
For seamless product synchronization from your platform to ViaAds, we have curated a guide that provides insights on how to create and manage a Product Feed. The guide is designed to simplify the process on your end.
Here is the link to the Custom Product Feed Guide.
Steps to Integrate ViaAds REST API:
Step 1: Securing an API Key
Contact the ViaAds support team to secure your API key. This unique key will serve as your authentication tool when you incorporate the API into your platform.
Step 2: Familiarize Yourself with API Documentation
Before going into the integration process, take time to review the API documentation. This document provides in-depth details about the available endpoints and parameters, both required and optional. Understanding these will help you determine the appropriate endpoints to utilize for your specific needs.
Step 3: API Integration
Integrate the ViaAds API into your platform using the provided API key for authentication. Be sure to follow the guidelines outlined in the API documentation to guarantee a correct and effective implementation.
Step 4: Daily Order Export
To ensure accurate tracking of your orders, a daily order export is essential. If for any reason you're unable to implement the Orders endpoint from the previous step, you can opt for a CSV export with a specified format. See the ViaAds Orders CSV Format for more information on this process.
Step 5: Update Your Cookie Consent Overview
Include ViaAds in your Cookie Consent Overview under the Marketing tab. This is a necessary step to inform your users about the use of cookies for advertising purposes.
Step 6: Add ViaAds Tracking Script
To finish up the integration, include the ViaAds tracking script in the <head> tag of your platform.
The data-marketing-consent attribute is used deliver the marking consent of a customer to ViaAds, which is tracked by the webshop.
<script type="text/javascript" id="viaads-custom-behavior" src="https://viaadspublicfiles.blob.core.windows.net/plugins/Integration/min/tracking.min.js" data-marketing-consent="True/False" async></script>
Here's the Link to API Documentation for further reference.
If you encounter any issues during the integration process, please contact Magnus Spanheimer by phone at +45 93 90 99 50 or by email at msp@viabill.com.