OkayAPI Docs


API Path: /api/App/ShortUrl/Gen

API Description: 针对长链接,生成对应的短链接。生成后可直接使用短链接,并且在小白开放平台的短链接,可以进行管理和查看,并统计访问次数。

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
urlStringRequired完整的长链接,建议以http或https开头,例如:https://www.yesapi.cn/。如果缺少http为开头,则访问时自动会添加 http://
titleStringRequired链接标题

API Debug

KEYREQUIREDVALUE
app_key *Required
url *Required
title *Required

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
err_msgString错误提示信息,err_code非0时参考此提示信息
urlString本次传递的长链接
short_urlString本次生成的短链接
codeString短链接代码编号

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error