Creating Endlinks
To use Endlinks you first need to create a packet with an endlink question and submit it to TARTLE for review. Here's a quick guide for the process.
Create a packet
- Log in to your buyer account
- Go to the packet suggestion page
- Give your packet a short name and a good description.
- Click 'ADD' in the question input box
- Enter the title and description for this question, be sure to include details on what they will be required to do when on your site and what is the benefit of doing so.
- Select 'Endlink' as the answer type
- Enter the link to your site.
The system will automatically add a tartle_endlink_token
url parameter to
the link. This token is unique to every user & packet, and you will use it to
report the results of the endlink. See the parameters section
below for more details.
For example, you could use a packet with an endlink to direct users to open an account with your company, the packet would be published once they have successfully done so. If you have a standing bid for 30 packets at $10 a packet, you will effectively be paying the first 30 users to sign up a $10 bonus.
This is a simple example, but the actions taken on your site could be anything you want. You just need to take care of correctly reporting the results to TARTLE following the next guide.
Endlink parameters
The system will automatically add a tartle_endlink_token
and seller_id
url parameter to the link without you having to
do anything. You will need the token as explained on the rest of the guides in this documentation section. The seller_id
is added for your convenience if you need it for associating your user with ours.
However, in some cases you may need more information or more control over the name of the parameter. In that case you can use double curly braces with a variable name to rename the url parameter when you're creating the question.
For example the example above, if your system required the token be named simply token
then you would
enter https://teams.com?token={{endlink_token}}
as the endlink url.
The supported variables are:
- Name
endlink_token
- Type
- string
- Description
The token that was present as a parameter to the endlink URL when the user landed on your site from TARTLE, use this when you need to change the name of the default
tartle_endlink_token
parameter.
- Name
seller_id
- Type
- string
- Description
The id of the seller that clicked the link, use this when you need to change the name of the
seller_id
parameter.
- Name
packet_unique_seller_id
- Type
- string
- Description
This property is not included automatically but you can add it using double curly braces. You could need this if you have several packets with us and you need to identify this particular user + packet interaction in your system
You do not need to add anything to your url if you don't need to change
the name of the default parameters, tartle_endlink_token
and seller_id
are
added automatically by the system.
The TARTLE packet review process
Once you have submitted your packet, it will be reviewed by TARTLE. If you'd like to speed up the process, you can contact us at support@tartle.co to request an expedited review.
Next you will need to integrate token handling on your site. You can do this on the server or the client. We strongly recommend doing this on the server side as it is more reliable than doing it on the browser due to browser versions, browser security, and other issues.
Continue on to token handling