POSTPublicapi-shortUrl-create

URL Shortener

Provides a URL shortener API service, enabling developers to quickly generate short links and integrate them into business systems.

Documentation

URL Shortener API Overview

The URL Shortener API helps developers quickly generate short links within their systems. It returns structured results and is ideal for business integration, automated API calls, and system docking.

Use Cases

Integrate URL shortening capabilities into internal systems, SaaS platforms, automated workflows, or operational backends.
Suitable for business scenarios requiring stable API calls, standardized responses, and orchestratable interfaces.
We recommend combining this with rate limiting, failure retries, and result caching strategies to improve overall integration stability.

Integration Guidelines

Before integrating, confirm the request parameter formats, authentication methods, and error code handling logic.
For high-frequency generation scenarios, it is recommended to implement log tracking, timeout control, and idempotency handling.
If the results are used for risk control or automated decision-making, we advise applying secondary judgments based on your business rules rather than relying solely on the API response.

Integration Examples

Includes ready-to-use Shell, Python, Go, Java, and PHP examples for direct integration.

Request Example

{
  "longUrl": "https://www.toolkk.com/apis/idcard-validate",
  "length": 6
}

Response Example

{
  "code": "SUCCESS",
  "message": "success",
  "data": {
    "shortUrl": "https://t.kk/abc123",
    "longUrl": "https://www.toolkk.com/apis/idcard-validate"
  }
}

Request Fields

The fields below are derived from example JSON for integration reference only.

Path	Type	Sample
longUrl	string	https://www.toolkk.com/apis/idcard-validate
length	number	6

Response Fields

The fields below are derived from example JSON for integration reference only.

Path	Type	Sample
code	string	SUCCESS
message	string	success
data	object	{...}
data.shortUrl	string	https://t.kk/abc123
data.longUrl	string	https://www.toolkk.com/apis/idcard-validate

curl --request POST \ --url 'https://openapi.toolkk.com/v1/api-shortUrl-create' \ --header 'Content-Type: application/json' \ --header 'X-API-Key: YOUR_API_KEY' \ --data '{\n "longUrl": "https://www.toolkk.com/apis/idcard-validate",\n "length": 6\n}'

import os import requests url = "https://openapi.toolkk.com/v1/api-shortUrl-create" payload = { "longUrl": "https://www.toolkk.com/apis/idcard-validate", "length": 6 } headers = { "Content-Type": "application/json", "X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"), } response = requests.request("POST", url, headers=headers, json=payload, timeout=30) response.raise_for_status() print(response.json())

package main import ( "bytes" "fmt" "io" "net/http" ) func main() { endpoint := "https://openapi.toolkk.com/v1/api-shortUrl-create" payload := []byte("{\n \"longUrl\": \"https://www.toolkk.com/apis/idcard-validate\",\n \"length\": 6\n}") req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload)) if err != nil { panic(err) } req.Header.Set("Content-Type", "application/json") req.Header.Set("X-API-Key", "YOUR_API_KEY") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() body, err := io.ReadAll(resp.Body) if err != nil { panic(err) } fmt.Println(string(body)) }

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class ToolkkExample { public static void main(String[] args) throws Exception { String payload = "{\n \"longUrl\": \"https://www.toolkk.com/apis/idcard-validate\",\n \"length\": 6\n}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://openapi.toolkk.com/v1/api-shortUrl-create")) .method("POST", HttpRequest.BodyPublishers.ofString(payload)) .header("Content-Type", "application/json") .header("X-API-Key", "YOUR_API_KEY") .build(); HttpResponse<String> response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } }

<?php $endpoint = 'https://openapi.toolkk.com/v1/api-shortUrl-create'; $payload = "{\n \"longUrl\": \"https://www.toolkk.com/apis/idcard-validate\",\n \"length\": 6\n}"; $ch = curl_init($endpoint); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Content-Type: application/json', 'X-API-Key: YOUR_API_KEY', ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); if ($response === false) { throw new RuntimeException(curl_error($ch)); } curl_close($ch); echo $response;

URL Shortener

Documentation

URL Shortener API Overview

Use Cases

Integration Guidelines

Integration Examples

Request Example

Response Example

Request Fields

Response Fields

Shell Example

Python Example

Go Example

Java Example

PHP Example

Try it online