Docs/API Reference

API Reference

Complete documentation for the Wee-Kit REST API. Create and manage deep links programmatically.

Authentication

The Wee-Kit API uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.

Important: Keep your API Secret secure. Never expose it in client-side code or public repositories.

Required Headers

Header	Description
`X-API-Key`	Your public API key (starts with `dk_`)
`X-API-Secret`	Your secret API key (starts with `sk_`)
`Content-Type`	`application/json` for POST/PATCH requests

curl -X GET https://api.wee-kit.app/v1/links \
  -H "X-API-Key: dk_live_your_api_key" \
  -H "X-API-Secret: sk_live_your_api_secret"

Base URL

All API requests should be made to:

https://api.wee-kit.app/v1

Errors

The API uses standard HTTP status codes to indicate success or failure.

Status	Description
`200`	Success
`201`	Created
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid API Key
`403`	Forbidden - Invalid API Secret or insufficient permissions
`404`	Not Found - Resource does not exist
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error

POST

/v1/links

Create a new deep link.

Request Body

Parameter	Type	Required	Description
`url`	string	Yes	Destination URL for the deep link
`title`	string	No	Display title for the link
`metadata`	object	No	Custom key-value data (campaign, source, etc.)
`expiresAt`	string	No	ISO 8601 expiration date

Example Request

curl -X POST https://api.wee-kit.app/v1/links \
  -H "X-API-Key: dk_live_your_api_key" \
  -H "X-API-Secret: sk_live_your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://myapp.com/product/123",
    "title": "Summer Sale Product",
    "metadata": {
      "campaign": "summer_sale",
      "source": "email"
    }
  }'

Response

201 Created

{
  "id": "link_abc123def456",
  "shortCode": "a1b2c3",
  "shortUrl": "https://myapp.wee-kit.app/l/a1b2c3",
  "url": "https://myapp.com/product/123",
  "title": "Summer Sale Product",
  "metadata": {
    "campaign": "summer_sale",
    "source": "email"
  },
  "clicks": 0,
  "createdAt": "2026-03-06T12:00:00Z",
  "updatedAt": "2026-03-06T12:00:00Z"
}

GET

/v1/links/:id

Retrieve a link by its ID.

Example Request

curl https://api.wee-kit.app/v1/links/link_abc123def456 \
  -H "X-API-Key: dk_live_your_api_key" \
  -H "X-API-Secret: sk_live_your_api_secret"

GET

/v1/links

List all links with pagination.

Query Parameters

Parameter	Type	Description
`page`	integer	Page number (default: 1)
`limit`	integer	Items per page (default: 20, max: 100)

Example Request

curl "https://api.wee-kit.app/v1/links?page=1&limit=20" \
  -H "X-API-Key: dk_live_your_api_key" \
  -H "X-API-Secret: sk_live_your_api_secret"

PATCH

/v1/links/:id

Update an existing link.

Example Request

curl -X PATCH https://api.wee-kit.app/v1/links/link_abc123def456 \
  -H "X-API-Key: dk_live_your_api_key" \
  -H "X-API-Secret: sk_live_your_api_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Updated Title",
    "metadata": {
      "campaign": "winter_sale"
    }
  }'

DELETE

/v1/links/:id

Delete a link permanently.

Example Request

curl -X DELETE https://api.wee-kit.app/v1/links/link_abc123def456 \
  -H "X-API-Key: dk_live_your_api_key" \
  -H "X-API-Secret: sk_live_your_api_secret"

GET

/v1/links/:id/stats

Get click statistics for a link.

Example Request

curl https://api.wee-kit.app/v1/links/link_abc123def456/stats \
  -H "X-API-Key: dk_live_your_api_key" \
  -H "X-API-Secret: sk_live_your_api_secret"

Response

200 OK

{
  "linkId": "link_abc123def456",
  "totalClicks": 1542,
  "uniqueClicks": 1203,
  "platforms": {
    "ios": 645,
    "android": 512,
    "web": 385
  },
  "countries": {
    "US": 520,
    "UK": 312,
    "DE": 198,
    "other": 512
  },
  "clicksByDay": [
    { "date": "2026-03-01", "clicks": 145 },
    { "date": "2026-03-02", "clicks": 203 },
    { "date": "2026-03-03", "clicks": 178 }
  ]
}