Documentação da API v1

Suporta geração de link único, geração em lote, links curtos Mini App e geração de QR code.

Descrição da interface
  • Endpoint：https://suo.run/api/v1
  • Método de requisição：POST
  • Tipo de conteúdo：application/json
  • Formato de resposta：code / msg / data
  • Método de autenticação：API Key （ Criar chave de API ）
Cabeçalhos de exemplo
Content-Type: application/json
X-API-Key: Sua chave de API
POST /api/v1/generate Gerar link curto
Descrição dos parâmetros
Parâmetro Descrição
url Link original
expire Dias de validade
custom_code Código curto personalizado
password Senha de acesso
ua_stay Política da plataforma de acesso
ua_plan Lista de permissões da plataforma de acesso
site_id ID de configuração de domínio curto
Exemplo de requisição
{
  "url": "https://example.com",
  "expire": 7,
  "custom_code": "",
  "password": "",
  "ua_stay": 0,
  "ua_plan": ["IOS","Android","PC","other"],
  "site_id": 1
}
Exemplo de resposta
{
  "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 Geração em lote
Descrição dos parâmetros
Parâmetro Descrição
urls Lista de URLs (máx. 100)
expire Dias de validade
password Senha de acesso
ua_stay Política da plataforma de acesso
ua_plan Lista de permissões da plataforma de acesso
site_id ID de configuração de domínio curto
Exemplo de requisição
{
  "urls": [
    "https://example.com/a",
    "https://example.com/b"
  ],
  "expire": 7,
  "password": "",
  "ua_stay": 0,
  "ua_plan": ["IOS","Android","PC","other"],
  "site_id": 1
}
Exemplo de resposta
{
  "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 Link curto Mini App
Descrição dos parâmetros
Parâmetro Descrição
appid Mini App AppID
appsecret Mini App AppSecret
page Caminho da página Mini App (suporta ?query)
expire Dias de validade
custom_code Código curto personalizado
password Senha de acesso
ua_stay Política da plataforma de acesso
ua_plan Lista de permissões da plataforma de acesso
site_id ID de configuração de domínio curto
Exemplo de requisição
{
  "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
}
Exemplo de resposta
{
  "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 Geração de QR code
Descrição dos parâmetros
Parâmetro Descrição
url Link original
expire Dias de validade
custom_code Código curto personalizado
password Senha de acesso
ua_stay Política da plataforma de acesso
ua_plan Lista de permissões da plataforma de acesso
site_id ID de configuração de domínio curto
Exemplo de requisição
{
  "url": "https://example.com",
  "expire": 7,
  "custom_code": "",
  "password": "",
  "ua_stay": 0,
  "ua_plan": ["IOS","Android","PC","other"],
  "site_id": 1
}
Exemplo de resposta
{
  "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"
  }
}