API Reference

Overview

LinkPilot API cho phép bạn quản lý short links, domains và analytics thông qua các endpoint RESTful.

Authentication

Mọi request đều yêu cầu API Key. Có 2 cách truyền key:

Header (Khuyến nghị)

Authorization: Bearer lp_your_api_key_here

Query Parameter

GET /api/v1/links?api_key=lp_your_api_key_here

Response khi không xác thực

{
  "success": false,
  "error": "Unauthorized"
}

HTTP Status: 401 Unauthorized

Response Format

Thành công

{
  "success": true,
  "data": { ... }
}

Lỗi

{
  "success": false,
  "error": "Error message here"
}

Endpoints

{
  "name": "Shopee Christmas Sale",
  "slug": "xmas-sale",
  "default_url": "https://shopee.vn/sale/christmas",
  "domain_id": "clxxx...",
  "is_enabled": true,
  "expires_at": "2025-12-31T23:59:59Z",
  "geo_targets": [
    {
      "country_code": "VN",
      "target_url": "https://shopee.vn/sale"
    }
  ]
}

Error Codes

Code Examples

cURL

curl -X POST "https://linkpilot.theyourlist.com/api/v1/links" \
  -H "Authorization: Bearer lp_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"Test Link","slug":"test","default_url":"https://google.com","domain_id":"clxxx"}'

JavaScript

const response = await fetch('https://linkpilot.theyourlist.com/api/v1/links', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer lp_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Test Link',
    slug: 'test',
    default_url: 'https://google.com',
    domain_id: 'clxxx'
  })
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.post(
    'https://linkpilot.theyourlist.com/api/v1/links',
    headers={
        'Authorization': 'Bearer lp_your_api_key',
        'Content-Type': 'application/json'
    },
    json={
        'name': 'Test Link',
        'slug': 'test',
        'default_url': 'https://google.com',
        'domain_id': 'clxxx'
    }
)

print(response.json())

PHP

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://linkpilot.theyourlist.com/api/v1/links',
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer lp_your_api_key',
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'name' => 'Test Link',
        'slug' => 'test',
        'default_url' => 'https://google.com',
        'domain_id' => 'clxxx'
    ]),
    CURLOPT_RETURNTRANSFER => true
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));

Rate Limiting

• Limit: 1000 requests / phút / API Key
• Headers:
  • X-RateLimit-Limit: Giới hạn
  • X-RateLimit-Remaining: Số request còn lại
  • X-RateLimit-Reset: Thời điểm reset (Unix timestamp)