RIVALSA文档中心

生成短网址

发布时间:2022-05-02 12:34:00

接口描述

您可以通过本接口为一个较长的网址(以下简称为原网址)生成一个短网址,当访问短网址时,会自动转跳到原网址。若原网址已经生成过短网址,本接口会直接返回曾生成过的短网址,而不会生成新的短网址。

本接口服务地址:https://api.rivalsa.net/v2/gf0AddURL.php

本接口的 action:gf0AddURL

输入参数

下表列出的参数需要放在请求体中,除此之外还需要在请求头部中添加公共请求头部

字段 必选 类型 描述
keyword String 您想生成的短网址的关键字,此关键字会放在短网址 https://gf0.ltd/ 的后面。例如,您设置的 keyword 为 eg 则生成的短网址为 https://gf0.ltd/eg。若此字段为空字符串,则由系统生成短网址。如果您转跳到的 URL 已存在,则会忽略此字段。
url String 您想转跳到的 URL。

输出参数

您调用本接口后,会返回公共响应头部公共响应体

当您调用成功时,公共响应体的 response 字段的类型为 String 类型,其值为已生成的(或曾经生成过的)短网址。

错误码

下表列出的是本接口独有的错误码,除此之外错误码还包括公共错误码

错误码 描述
300 不支持您使用的请求方式。本接口仅支持 POST 请求。
301 不支持您使用的 Content-Type。Content-Type必须严格为 application/json;charset=UTF-8 一个字符都不能错。
302 输入参数 keyword 的类型不正确。keyword 必须为 String 类型。
303 输入参数 url 的类型不正确。url 必须为 String 类型。
304 输入参数 url 的格式不正确。url 必须以 http:// 或 https:// 开头,且后面至少有4个字符。
305 输入参数 keyword 已被占用,请更换后重试。
306 输入参数 keyword 格式不正确。keyword 只能由小写字母、数字组成,且仅支持3-5位字符。

示例

请求示例
POST https://api.rivalsa.net/v2/gf0AddURL.php

Content-Type:application/json;charset=UTF-8
Host:api.rivalsa.net
<公共响应头部>

{
    "keyword":"eg",
    "url":"https://博客.卅卅.我爱你"
}
成功响应体示例
{
    "code":0,
    "response":"https://gf0.ltd/eg",
    "requestID":3
}
失败响应体示例
{
    "code":305,
    "msg":"keyword重复",
    "requestID":4
}