Tracker settings
Kaitaro

Keitaro Integration

Created by: Alexey(founder/dev) Last edited: October 2, 2024 7:09 PM

  • Quick references

    BASE_ORDER_CREATION_URL = https://crm.advibe.me/server/api/v1/order
 
method: ‘POST’

    Required fields:

    orderSupplierUuid - your unique identifier as a web master [from our system]

    product - uniq id of the product [from our system]

    clickId - id of a lead. If you are familiar with Keitaro clickId stands for subId [from your system]

    shippingInfo:

    country_code - the GEO of customer [accepts only two digits; examples: GT, CO, UK, ES etc..]

    fullName - the name of the customer

    phone - the phone number of the customer

    Optional fields:

    note - comment from the customer

    productCount - amount of packages customer ordered

    totalCost - total amount in USD of customer’s order

    shippingInfo:

    region - customer’s region

    city - customer’s city

    address - customer’s address

    house - customer’s house

    zip - customer’s zip code

The full integration get via simple steps. We will dig in all of them from scratch.

  1. Receiving orderSupplierUuid, read more (opens in a new tab). It is a unique identifier within our system. We use it to track your incoming leads, separating statistic and postback logs.

  2. Getting product id read more (opens in a new tab). It is a unique identifier within our system.

  3. Providing tracker provider and postback url. This is the step where we need to receive some information of your main system just to make feedback solutions.

  4. Sending leads to our system. As any other providers, we support API based integration meaning that anything and under any circumstances can be sent to our system.

    There are two ways for sending leads to our system:

    • Integration via API call.

      If you are using any program language to process orders you can simply call our API to provide lead to our side. To make so, you need to make a POST request to BASE_ORDER_CREATION_URL with bunch of properties. Some of them are required, some of them are optional. You can find all available fields in Quick references.

    • Integration via form.

      The most popular solution is a form sender that basically do an API call to our system, so mostly this partially relied on 4.1 (opens in a new tab). You can find all available fields in Quick references. Example of form sender with all required fields:

      <form
	action=”https://crm.advibe.me/server/api/v1/order”
	method="post"
>
 
	<!--Hidden fields. NEED TO BE CHANGED-→
 
	<input type='hidden' name='orderSupplierUuid' value='YOUR_UUID'>
	<input type='hidden' name='product' value='PRODUCT_ID'>
	<input type='hidden' name='shippingInfo[country_code]' value='GEO'>
	<input type='hidden' name='clickId' value='LEAD_ID'>
 
	<!--Visible fields. NEED TO BE CONFIGURED-→
	<input name='shippingInfo[fullName]' value='CUSTOMER NAME'>
	<input name='shippingInfo[phone]' value='CUSTOMER PHONE'>
</form>
Tracker settings