API Reference

Complete reference for the Linkbay Merchant API. All endpoints require API key authentication.

Base URL

https://api.linkbay.io

Available Endpoints

Authentication

Learn how to authenticate your API requests using API keys.

Lookup Click

GET /api/v1/merchant/lookup-click

Retrieve the expected affiliate tag for a given click ID.

Verify Click

POST /api/v1/merchant/verify-click

Verify a click and report the conversion outcome.

Webhooks

Receive real-time notifications when clicks occur.

Response Format

All API responses are returned as JSON. Successful responses include the requested data directly. Error responses include an error field with a description.

Success Response

{
  "clickId": "xyz789",
  "expectedTag": "CREATOR123",
  "creatorId": "abc123",
  "timestamp": "2026-01-15T10:30:00Z"
}

Error Response

{
  "error": "Click not found or expired"
}

Rate Limits

API requests are rate limited to ensure fair usage. Current limits:

100 requests per minute per API key
1000 requests per hour per API key

Rate limit headers are included in all responses:

X-RateLimit-Limit: Maximum requests allowed
X-RateLimit-Remaining: Requests remaining in window
X-RateLimit-Reset: Unix timestamp when limit resets