调用价格
10 匠币/次
快速接入
保持统一返回结构,直接通过服务端发起请求即可接入。
https://openapi.toolkk.com/v1/api-shortUrl-createcURL 示例
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}'Python 示例
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())Go 示例
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))
}Java 示例
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 示例
<?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;响应示例
{
"code": "SUCCESS",
"message": "success",
"data": {
"shortUrl": "https://t.kk/abc123",
"longUrl": "https://www.toolkk.com/apis/idcard-validate"
}
}示例用于理解返回结构,实际结果以接口返回为准。
- 鉴权方式
- 请求头传入 X-API-Key
- 默认限流
- 600 次/分钟
- 超时时间
- 5000 ms
服务端调用时,将 API Key 放在 X-API-Key 请求头中。
建议按 response code 与业务字段双重判断调用结果。
高频调用场景请结合速率限制与重试策略使用。
请求字段
从服务端发起请求,并在 X-API-Key 请求头中传入密钥。
请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| longUrl | string | 未标注 | 未标注 | https://www.toolkk.com/apis/idcard-validate |
| length | number | 未标注 | 未标注 | 6 |
请求示例
{
"longUrl": "https://www.toolkk.com/apis/idcard-validate",
"length": 6
}- 鉴权方式
- 请求头传入 X-API-Key
- 默认限流
- 600 次/分钟
- 超时时间
- 5000 ms
响应字段
示例用于理解返回结构,实际结果以接口返回为准。
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| 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 |
响应示例
{
"code": "SUCCESS",
"message": "success",
"data": {
"shortUrl": "https://t.kk/abc123",
"longUrl": "https://www.toolkk.com/apis/idcard-validate"
}
}$.code == 200 接口简介
接口能力、应用场景、使用限制与常见问题。
将长链接转换为短链接
提交一条长链接后,接口生成较短的链接地址,并返回对应的原始长链接,方便在消息、文案或其他发布渠道中使用。请求中的长度设置用于控制短码相关长度,允许值按接口字段说明处理。生成短链不会自动证明目标网站安全或目标内容长期可用。
应用场景
- 消息发送:将业务页面地址缩短后加入已有通知流程,发布前检查跳转目标。
- 运营内容:在文案、客服回复或线下材料中使用短链,减少地址展示长度。
- 二维码流程:调用方将返回短链交给二维码生成能力,再做扫码与落地页验证;本接口本身不生成二维码图片。
使用与结果解读
把完整目标地址放入 longUrl,保留跳转所需的查询参数和正确编码,按请求字段设置 length。成功后读取 data.shortUrl 作为短链,用返回的 data.longUrl 核对对应原地址。正式发布前实际访问短链,确认到达正确页面,并检查目标页面是否需要登录或受访问条件限制。
链接使用边界
当前公开示例没有访问统计、自定义域名、过期时间管理或批量输入,不应把这些能力视为已具备。也未公开统一的短链有效期与永久保存承诺;需要长期发布的业务,应先确认适用条件。目标地址中的临时签名、令牌或个人资料不会因为链接变短而消失,使用前应检查分享范围与访问权限。
常见问题
length 可以传任意数字吗?
不能这样假定。示例中的 6 不是任意长度都支持的说明,实际允许值按请求字段与接口校验结果设置。
返回 shortUrl 就说明目标地址安全吗?
不是。短链结果是地址映射,不是网站安全或内容审核结论;调用方仍需核对目标与分享对象。