API 문서 v1

단일 링크 생성, 배치 생성, 미니앱 단축 링크, QR 코드 생성 지원.

인터페이스 안내
  • 엔드포인트：https://suo.run/api/v1
  • 요청 방식：POST
  • 콘텐츠 타입：application/json
  • 응답 형식：code / msg / data
  • 인증 방식：API Key （ API 키 생성 ）
예시 요청 헤더
Content-Type: application/json
X-API-Key: 당신의 API 키
POST /api/v1/generate 단축 링크 생성
매개변수 설명
매개변수 설명
url 원본 링크
expire 유효 기간(일)
custom_code 사용자 정의 단축 코드
password 접근 비밀번호
ua_stay 접근 플랫폼 정책
ua_plan 접근 플랫폼 허용 목록
site_id 단축 도메인 설정 ID
예시 요청
{
  "url": "https://example.com",
  "expire": 7,
  "custom_code": "",
  "password": "",
  "ua_stay": 0,
  "ua_plan": ["IOS","Android","PC","other"],
  "site_id": 1
}
예시 응답
{
  "code": 1,
  "msg": "success",
  "data": {
    "original_url": "https://example.com",
    "short_url": "http://j58s.298.run",
    "short_code": "j58s",
    "expire_time": "2026-02-13 00:15:25",
    "site_url": "j58s.298.run"
  }
}
POST /api/v1/batchGenerate 배치 생성
매개변수 설명
매개변수 설명
urls URL 목록(최대 100개)
expire 유효 기간(일)
password 접근 비밀번호
ua_stay 접근 플랫폼 정책
ua_plan 접근 플랫폼 허용 목록
site_id 단축 도메인 설정 ID
예시 요청
{
  "urls": [
    "https://example.com/a",
    "https://example.com/b"
  ],
  "expire": 7,
  "password": "",
  "ua_stay": 0,
  "ua_plan": ["IOS","Android","PC","other"],
  "site_id": 1
}
예시 응답
{
  "code": 1,
  "msg": "success",
  "data": {
    "results": [
      {
        "original_url": "https://example.com/a",
        "short_url": "http://bf63sr.298.run",
        "site_url": "bf63sr.298.run"
      },
      {
        "original_url": "https://example.com/b",
        "short_url": "http://3yj2oy.298.run",
        "site_url": "3yj2oy.298.run"
      }
    ],
    "expire_time": "2026-02-13 00:05:11",
    "errors": [],
    "total": 2,
    "success_count": 2,
    "error_count": 0
  }
}
POST /api/v1/miniApp 미니앱 단축 링크
매개변수 설명
매개변수 설명
appid 미니앱 AppID
appsecret 미니앱 AppSecret
page 미니앱 페이지 경로(?query 지원)
expire 유효 기간(일)
custom_code 사용자 정의 단축 코드
password 접근 비밀번호
ua_stay 접근 플랫폼 정책
ua_plan 접근 플랫폼 허용 목록
site_id 단축 도메인 설정 ID
예시 요청
{
  "appid": "미니앱 AppID",
  "appsecret": "미니앱 AppSecret",
  "page": "pages/index",
  "expire": 7,
  "custom_code": "",
  "password": "",
  "ua_stay": 0,
  "ua_plan": ["IOS","Android","PC","other"],
  "site_id": 1
}
예시 응답
{
  "code": 1,
  "msg": "success",
  "data": {
    "original_url": "weixin://dl/business/?t=Sctv5oaz0Id",
    "short_url": "http://vmei.298.run",
    "short_code": "vmei",
    "expire_time": "2026-02-13 00:15:31",
    "site_url": "vmei.298.run"
  }
}
POST /api/v1/qcodeGenerate QR 코드 생성
매개변수 설명
매개변수 설명
url 원본 링크
expire 유효 기간(일)
custom_code 사용자 정의 단축 코드
password 접근 비밀번호
ua_stay 접근 플랫폼 정책
ua_plan 접근 플랫폼 허용 목록
site_id 단축 도메인 설정 ID
예시 요청
{
  "url": "https://example.com",
  "expire": 7,
  "custom_code": "",
  "password": "",
  "ua_stay": 0,
  "ua_plan": ["IOS","Android","PC","other"],
  "site_id": 1
}
예시 응답
{
  "code": 1,
  "msg": "success",
  "data": {
    "original_url": "https://example.com",
    "short_url": "http://8fw6.298.run",
    "short_code": "8fw6",
    "expire_time": "2026-02-13 00:15:32",
    "site_url": "8fw6.298.run",
    "qr_url": "https://api.qrserver.com/v1/create-qr-code/?size=300x300&data=http%3A%2F%2F8fw6.298.run"
  }
}