API दस्तावेज़ v1

एकल लिंक जनरेशन, बैच जनरेशन, Mini App शॉर्ट लिंक और 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 Mini App शॉर्ट लिंक
पैरामीटर विवरण
पैरामीटर विवरण
appid Mini App AppID
appsecret Mini App AppSecret
page Mini App पेज पाथ (?query समर्थित)
expire वैधता दिन
custom_code कस्टम शॉर्ट कोड
password एक्सेस पासवर्ड
ua_stay एक्सेस प्लेटफ़ॉर्म नीति
ua_plan एक्सेस प्लेटफ़ॉर्म व्हाइटलिस्ट
site_id शॉर्ट डोमेन कॉन्फ़िग ID
उदाहरण अनुरोध
{
  "appid": "Mini App AppID",
  "appsecret": "Mini App 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"
  }
}