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"
  }
}