APIUSB / OpenAPI / 域名绿V接口

域名绿V接口

接口描述:在线短域名生成

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
url字符串必须-需要缩短的网址,如:http://www.baidu.com
code字符串可选-自定义短网址后缀,留空则随机生成

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
url 必须
code 可选

客户端请求示例

Request:
{Your endpoint domain}/?s=App.Idc.DomainGetGreen&url=www.baidu.com

Response:
{
"ret": 200, "data": {"code": "200", "msg":"success", "url_long": "http:\\\/\\\/www.baidu.com", "url_short": "https:\\\/\\\/api.66mz8.com\\\/baidu"}, "msg": ""
}
curl https://api.apiusb.com/api/app?s=App.Idc.DomainGetGreen&url=www.baidu.com
{"ret":200,"data":{"code":"200","msg":"success","url_long":"http:\\\/\\\/www.baidu.com","url_short":"https:\\\/\\\/api.66mz8.com\\\/baidu"},"msg":""}

$.ajax({
    url: "https://api.apiusb.com/api/app",
    data: {s: "https://api.apiusb.com/api/app", url: "www.baidu.com"},
    dataType: 'json',
    success: function (response, status, xhr) {
        console.log(response);
    }
});
<?php
require_once dirname(__FILE__) . '/PhalApiClient.php';

$client = PhalApiClient::create()
    ->withHost('https://api.apiusb.com/api/app');$rs = $client->reset()
->withService('App.Idc.DomainGetGreen')
->withParams('url', 'www.baidu.com')
->withTimeout(3000)
->request();

// ret状态码,200表示成功
var_dump($rs->getRet());
// 业务数据
var_dump($rs->getData());
// 提示信息
var_dump($rs->getMsg());
#-*- coding:utf-8 -*-
import PhalApiClient

result = PhalApiClient.PhalApiClient('https://api.apiusb.com/api/app', 'App.Idc.DomainGetGreenx', {'url': 'www.baidu.com'}, 3)
//FullscreenActivity.java
import net.phalapi.sdk.*;    /**
     * 网络操作相关的子线程
     */  
    Runnable networkTask = new Runnable() {  
      
        @Override  
        public void run() {  
            // TODO  
            // 在这里进行 http request.网络请求相关操作  
            
        	PhalApiClient client = PhalApiClient.create()
	       			    .withHost("https://api.apiusb.com/api/app");
	       	
	       	PhalApiClientResponse response = client
	       			    .withService("App.Idc.DomainGetGreen")
	       			    .withParams("url", "www.baidu.com")
	       			    .withTimeout(3000)
	       			    .request();

	   		String content = "";
	   		content += "ret=" + response.getRet() + "\n";
	   		if (response.getRet() == 200) {
				try {
					JSONObject data = new JSONObject(response.getData());
					content += "data.title=" + data.getString("title") + "\n";
					content += "data.content=" + data.getString("content") + "\n";
					content += "data.version=" + data.getString("version") + "\n";
				} catch (JSONException ex) {
					  
				}
	   		}
			content += "msg=" + response.getMsg() + "\n";
			
			Log.v("[PhalApiClientResponse]", content);
            
            
            Message msg = new Message();  
            Bundle data = new Bundle();  
            data.putString("value", content);  
            msg.setData(data);  
            handler.sendMessage(msg);  
        }  
    }; 
PhalApiClientResponse response = PhalApiClient.create()
  .withHost("https://api.apiusb.com/api/app")
  .withService("App.Idc.DomainGetGreen")
  .withparamsList("url", "www.baidu.com")
  .withTimeout(3000)
  .request();

Log.v("response ret", response.ret + "");
Log.v("response data", response.data);
Log.v("response msg", response.msg);
#import "AFNPhalApiClient.h"// POST
NSDictionary *params = @{@"url": @"www.baidu.com"};

// Call AFNPhalApiClient
[[[[[AFNPhalApiClient sharedClient] withHost:@"https://api.apiusb.com/api/app"] withService:@"App.Idc.DomainGetGreen"] withParams:params] requestWithFormDataBlock:^(id formData) {
	//
    [formData appendPartWithFileData:UIImageJPEGRepresentation([UIImage imageNamed:@"head.JPG"], 1) name:@"file" fileName:@"image.jpg" mimeType:@"image/jpeg"];
} completeBlock:^(id resultObject) {
    PALog(@"resultObject: %@", resultObject);
} failureBlock:^(NSError *error) {
    PALog(@"error: %@", error);
}];

// Print url
PALog(@"total url: %@", [[AFNPhalApiClient sharedClient] printTotalUrlStr]);

错误列表

错误状态码错误描述信息
400表示客户端参数错误
404表示接口服务不存在
500表示服务端内部错误

本文档生成时间:2024-04-20 18:25:51