API Documentation

Overview

The LinkSnip API allows you to programmatically create, manage, and track shortened URLs. Our RESTful API supports JSON and provides endpoints for all the functionality available in the web interface.

Check the current operational status of the LinkSnip API and its components.

Authentication

All API requests require authentication using an API key. You can obtain an API key from your account dashboard.

curl -X POST https://api.linksnip.com/v1/shorten \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key_here" \
  -d '{"url": "https://example.com/very/long/url"}'

API Reference

curl -X POST https://api.linksnip.com/v1/shorten \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key_here" \
  -d '{
    "url": "https://example.com/very/long/url",
    "alias": "my-custom-link",
    "expiresAt": "2023-12-31T23:59:59Z"
  }'

{
  "success": true,
  "data": {
    "id": "a1b2c3d4",
    "originalUrl": "https://example.com/very/long/url",
    "shortUrl": "https://linksnip.com/s/my-custom-link",
    "alias": "my-custom-link",
    "expiresAt": "2023-12-31T23:59:59Z",
    "createdAt": "2023-05-15T14:30:45Z",
    "qrCode": "https://linksnip.com/qr/my-custom-link.png"
  }
}

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of a request. In case of an error, the response body will contain additional information.

{
  "success": false,
  "error": {
    "code": "invalid_url",
    "message": "The provided URL is invalid",
    "status": 400
  }
}

SDKs and Libraries

We provide official client libraries for popular programming languages to make integration easier.

npm install linksnip-api

pip install linksnip

composer require linksnip/api

Support

If you have any questions or need help with the API, please contact our support team.

API Playground

Test our API endpoints directly from your browser. No API key required for the playground.

{
  "success": true,
  "data": {
    "id": "a1b2c3d4",
    "originalUrl": "https://example.com/your-long-url",
    "shortUrl": "https://linksnip.com/s/my-custom-link",
    "alias": "my-custom-link",
    "expiresAt": null,
    "createdAt": "2023-05-15T14:30:45Z",
    "qrCode": "https://linksnip.com/qr/my-custom-link.png"
  }
}

API Changelog

Track the evolution of our API with the version history and changelog.