وثائق 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 معرّف إعداد نطاق قصير
مثال طلب
{
  "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 معرّف إعداد نطاق قصير
مثال طلب
{
  "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
appsecret سر تطبيق Mini App
page مسار صفحة Mini App (يدعم ?query)
expire أيام الصلاحية
custom_code رمز قصير مخصص
password كلمة مرور الوصول
ua_stay سياسة منصة الوصول
ua_plan قائمة السماح لمنصات الوصول
site_id معرّف إعداد نطاق قصير
مثال طلب
{
  "appid": "معرّف تطبيق Mini App",
  "appsecret": "سر تطبيق Mini App",
  "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 معرّف إعداد نطاق قصير
مثال طلب
{
  "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"
  }
}