Introduction - Clink Documentation

The Clink API is currently in development, and available features are limited.

Base Endpoints

The Clink API follows REST principles and requires HTTPS for all requests to ensure data security, integrity, and privacy. API endpoints for different environments:

Test Environment

https://uat-api.clinkbill.com

Production Environment

https://api.clinkbill.com

Authentication

Clink uses API keys in request headers for security. Additionally, a dynamic timestamp within a two-minute window is required.

{
  "headers": {
    "X-API-Key": "sk_test_*********************",
    "X-Timestamp": "${millisecondsTimestamp}"
  }
}

Response codes

We use standard HTTP status codes to indicate the outcome of API requests: 2xx codes indicate successful requests 4xx codes indicate client-side errors 5xx codes indicate server-side issues

Status	Description
200	Request successful
400	Invalid parameters or request format
401	Missing or invalid API key
403	Insufficient permissions for requested resource
404	Requested resource not found
429	Rate limit exceeded
500	Internal server error

TypeScript SDK

​Base Endpoints

​Authentication

​Response codes

Base Endpoints

Authentication

Response codes