Create Link

curl --request POST \
  --url https://api.taap.it/v1/links \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "original_url": "<string>",
  "enable_conversion_tracking": true
}
'

import requests

url = "https://api.taap.it/v1/links"

payload = {
    "original_url": "<string>",
    "enable_conversion_tracking": True
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({original_url: '<string>', enable_conversion_tracking: true})
};

fetch('https://api.taap.it/v1/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taap.it/v1/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'original_url' => '<string>',
    'enable_conversion_tracking' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taap.it/v1/links"

	payload := strings.NewReader("{\n  \"original_url\": \"<string>\",\n  \"enable_conversion_tracking\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.taap.it/v1/links")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"original_url\": \"<string>\",\n  \"enable_conversion_tracking\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.taap.it/v1/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"original_url\": \"<string>\",\n  \"enable_conversion_tracking\": true\n}"

response = http.request(request)
puts response.read_body

{
  "detail": "Invalid URL format"
}

{
  "detail": "Custom code already exists"
}

POST

links

Create Link

curl --request POST \
  --url https://api.taap.it/v1/links \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "original_url": "<string>",
  "enable_conversion_tracking": true
}
'

import requests

url = "https://api.taap.it/v1/links"

payload = {
    "original_url": "<string>",
    "enable_conversion_tracking": True
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({original_url: '<string>', enable_conversion_tracking: true})
};

fetch('https://api.taap.it/v1/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taap.it/v1/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'original_url' => '<string>',
    'enable_conversion_tracking' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taap.it/v1/links"

	payload := strings.NewReader("{\n  \"original_url\": \"<string>\",\n  \"enable_conversion_tracking\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.taap.it/v1/links")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"original_url\": \"<string>\",\n  \"enable_conversion_tracking\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.taap.it/v1/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"original_url\": \"<string>\",\n  \"enable_conversion_tracking\": true\n}"

response = http.request(request)
puts response.read_body

{
  "detail": "Invalid URL format"
}

{
  "detail": "Custom code already exists"
}

Create a new deeplink with custom codes, domains, password protection, expiration dates, and tracking features. Request:

cURL

curl -X POST 'https://api.taap.it/v1/links' \
  -H 'Authorization: Bearer taapit_your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "original_url": "https://example.com/very-long-url-that-needs-shortening"
  }'

Response:

{
  "id": "link_987654321",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "project_id": "project_123456789",
  "domain_id": "domain_987654321",
  "pixel_id": "pixel_456789123",
  "original_url": "https://example.com/very-long-url-that-needs-shortening",
  "name": "My Marketing Link",
  "description": "Link for summer campaign",
  "code": "summer2024",
  "app": "MyApp",
  "app_logo": "https://example.com/logo.png",
  "android_link": "myapp://open?url=https://example.com",
  "ios_link": "myapp://open?url=https://example.com",
  "windows_link": "ms-windows-store://pdp/?productid=9NBLGGH123456",
  "macos_link": "macappstore://itunes.apple.com/app/myapp/id123456789",
  "whatsapp_message": "Check out this amazing link!",
  "metadata": {
    "title": "Amazing Product",
    "description": "Check out our new product",
    "favicon": "https://example.com/favicon.ico",
    "social_image": "https://example.com/social-image.jpg"
  },
  "qr_code_options": {
    "size": 200,
    "color": "#000000",
    "background_color": "#ffffff",
    "logo": "https://example.com/logo.png",
    "logo_size": 50,
    "error_correction_level": "M"
  },
  "utm_name": "summer_campaign",
  "utm_source": "email",
  "utm_medium": "newsletter",
  "utm_campaign": "summer2024",
  "utm_term": "marketing",
  "utm_content": "cta_button",
  "utm_template_id": "template_123",
  "referrer": "https://example.com",
  "password": "secure123",
  "password_description": "Enter password to access link",
  "excluded_countries": [
    {
      "code": "US",
      "label": "United States",
      "phone": "+1",
      "suggested": true,
      "lang": "en",
      "continent": "North America"
    }
  ],
  "has_public_stat": true,
  "enable_conversion_tracking": true,
  "is_archived": false,
  "expiration_date": "2024-12-31T23:59:59Z",
  "expiration_click_count": 1000,
  "clicks": 0
}

Authorization

string

required

Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Request Parameters

string

required

The URL to be shortened. Supports http, https, mailto, tel, sms, whatsapp, tg, skype schemes.

boolean

Whether to enable conversion tracking on this link. When omitted, the default depends on your plan’s conversion tracking feature.

Response Fields

Core Fields

string

required

Unique identifier for the created link

string

required

ISO 8601 timestamp when the link was created

string

required

ISO 8601 timestamp when the link was last updated

string

ID of the associated project

string

ID of the custom domain used

string

ID of the associated tracking pixel

Link Content

string

required

The original URL that was shortened

string

Name of the link

string

Description of the link

string

required

The short code used in the URL

Deep Linking

string

Name of the mobile app for deep linking

string

URL to the app logo image

string

Android deep link URL

string

iOS deep link URL

string

Windows deep link URL

string

macOS deep link URL

string

Pre-filled message for WhatsApp sharing

Metadata & QR Code

object

Link metadata for website previews

Show Metadata properties

string

Page title for link previews

string

Page description for link previews

string

URL to favicon image

URL to social media preview image

object

QR code generation options

Show QR Code options

integer

QR code size in pixels

string

QR code color (hex format)

string

QR code background color (hex format)

string

URL to logo image embedded in QR code

integer

Logo size in pixels

string

Error correction level (L, M, Q, H)

UTM Parameters

string

UTM campaign name

string

UTM source

string

UTM medium

string

UTM campaign identifier

string

UTM term (keywords)

string

UTM content

string

UTM template identifier

string

Referrer URL

Security & Access

string

Password to protect the link

string

Description shown when password is required

array

Array of countries excluded from accessing the link

Show Excluded country properties

string

Country code (ISO 3166-1 alpha-2)

string

Country name

string

Country phone code

boolean

Whether this country is suggested for exclusion

string

Primary language code

string

Continent name

boolean

Whether link statistics are publicly accessible

Conversion Tracking

boolean

Whether conversion tracking is enabled on this link

Status Flags

boolean

Whether the link is archived

Expiration

string

ISO 8601 datetime when link expires

integer

Maximum number of clicks before link expires

Analytics

integer

Total number of clicks

Error Responses

{
  "detail": "Invalid URL format"
}

{
  "detail": "Custom code already exists"
}

Track Sale List Links

Getting started

Conversions

API Reference

Create Link

Authorization

Request Parameters

Response Fields

Core Fields

Link Content

Deep Linking

Metadata & QR Code

UTM Parameters

Security & Access

Conversion Tracking

Status Flags

Expiration

Analytics

Error Responses

​Authorization

​Request Parameters

​Response Fields

​Core Fields

​Link Content

​Deep Linking

​Metadata & QR Code

​UTM Parameters

​Security & Access

​Conversion Tracking

​Status Flags

​Expiration

​Analytics

​Error Responses

Authorization

Request Parameters

Response Fields

Core Fields

Link Content

Deep Linking

Metadata & QR Code

UTM Parameters

Security & Access

Conversion Tracking

Status Flags

Expiration

Analytics

Error Responses