所有文档
状态码 | 定义 | 注释 |
---|---|---|
0 | 正常 | |
1 | 服务器内部错误 | 该服务响应超时或系统内部错误,请留下联系方式 |
10 | 上传内容超过8M | Post上传数据不能超过8M |
101 | AK参数不存在 | 请求消息没有携带AK参数 |
102 | MCODE参数不存在,mobile类型mcode参数必需 | 对于Mobile类型的应用请求需要携带mcode参数,该错误码代表服务器没有解析到mcode |
200 | APP不存在,AK有误请检查再重试 | 根据请求的ak,找不到对应的APP |
201 | APP被用户自己禁用,请在控制台解禁 | |
202 | APP被管理员删除 | 恶意APP被管理员删除 |
203 | APP类型错误 | 当前API控制台支持Server(类型1), Mobile(类型2, 新版控制台区分为Mobile_Android(类型21)及Mobile_IPhone(类型22))及Browser(类型3),除此之外其他类型认为是APP类型错误 |
210 | APP IP校验失败 | 在申请Server类型应用的时候选择IP校验,需要填写IP白名单,如果当前请求的IP地址不在IP白名单或者不是0.0.0.0/0就认为IP校验失败 |
211 | APP SN校验失败 | Server类型APP有两种校验方式IP校验和SN校验,当用户请求的SN和服务端计算出来的SN不相等的时候提示SN校验失败 |
220 | APP Referer校验失败 | 浏览器类型的APP会校验referer字段是否存切在referer白名单里面,否则返回该错误码 |
230 | APP Mcode码校验失败 | 服务器能解析到mcode,但和数据库中不一致,请携带正确的mcode |
240 | APP 服务被禁用 | 用户在API控制台中创建或设置某APP的时候禁用了某项服务 |
250 | 用户不存在 | 根据请求的user_id, 数据库中找不到该用户的信息,请携带正确的user_id |
251 | 用户被自己删除 | 该用户处于未激活状态 |
252 | 用户被管理员删除 | 恶意用户被加入黑名单 |
260 | 服务不存在 | 服务器解析不到用户请求的服务名称 |
261 | 服务被禁用 | 该服务已下线 |
301 | 永久配额超限,限制访问 | 配额超限,如果想增加配额请联系我们 |
302 | 天配额超限,限制访问 | 配额超限,如果想增加配额请联系我们 |
401 | 当前并发量已经超过约定并发配额,限制访问 | 并发控制超限,请控制并发量或联系我们 |
402 | 当前并发量已经超过约定并发配额,并且服务总并发量也已经超过设定的总并发配额,限制访问 | 并发控制超限,请控制并发量或联系我们 |
API请求中需要用到中文或一些特殊字符的参数,为了避免提交到后台乱码,需要对这几个参数值进行编码处理,转换成UTF-8字符的二字符十六进制值,凡是不在下表中的字符都需要进行编码。
字符集合 | 字符 |
---|---|
URL非保留字 | a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 - _ . ~ |
URL保留字 | ! * ' ( ) ; : @ & = + $ , / ? % # [ ] |
如果中文参数中使用URL保留字字符的字面意思,例如:region关键字取值为"?北京",检索关键字包含一个问号,此问号也必须进行编码。
javascript中一般采用encodeURIComponent函数对特殊字符进行编码。
Java中可以使用函数URLEncoder.encode对特殊字符进行编码。
C#中可以使用函数HttpUtility.UrlEncode对特殊字符进行编码。
php中可以使用函数urlencode对特殊字符进行编码。
假设ak=yourak(yourak为一个字符串),在API控制台中配置了该ak的验证方式是sn签名的验证方式,点击下面那排星号,显示Security Key,可以看到此ak对应的sk私钥,假设sk=yoursk。请求的url是:
http://api.map.baidu.com/geocoder/v2/?address=百度大厦&output=json&ak=yourak&sn=7de5a22212ffaa9e326444c75a58f9a0
//后面的sn就是要计算的,sk不需要在url里出现,但是在计算sn的时候需要sk(假设sk=yoursk) 下面提供java、PHP、C#、python 2.7的参考代码。
java参考代码如下:
package test;import java.io.UnsupportedEncodingException;import java.net.URLEncoder;import java.security.NoSuchAlgorithmException;import java.util.LinkedHashMap;import java.util.Map;import java.util.Map.Entry;//java版计算signature签名public class SnCal {public static void main(String[] args) throws UnsupportedEncodingException,NoSuchAlgorithmException {SnCal snCal = new SnCal();// 计算sn跟参数对出现顺序有关,get请求请使用LinkedHashMap保存<key,value>,该方法根据key的插入顺序排序;post请使用TreeMap保存<key,value>,该方法会自动将key按照字母a-z顺序排序。所以get请求可自定义参数顺序(sn参数必须在最后)发送请求,但是post请求必须按照字母a-z顺序填充body(sn参数必须在最后)。以get请求为例:http://api.map.baidu.com/geocoder/v2/?address=百度大厦&output=json&ak=yourak,paramsMap中先放入address,再放output,然后放ak,放入顺序必须跟get请求中对应参数的出现顺序保持一致。Map paramsMap = new LinkedHashMap<String, String>();paramsMap.put("address", "百度大厦");paramsMap.put("output", "json");paramsMap.put("ak", "yourak");// 调用下面的toQueryString方法,对LinkedHashMap内所有value作utf8编码,拼接返回结果address=%E7%99%BE%E5%BA%A6%E5%A4%A7%E5%8E%A6&output=json&ak=yourakString paramsStr = snCal.toQueryString(paramsMap);// 对paramsStr前面拼接上/geocoder/v2/?,后面直接拼接yoursk得到/geocoder/v2/?address=%E7%99%BE%E5%BA%A6%E5%A4%A7%E5%8E%A6&output=json&ak=yourakyourskString wholeStr = new String("/geocoder/v2/?" + paramsStr + "yoursk");// 对上面wholeStr再作utf8编码String tempStr = URLEncoder.encode(wholeStr, "UTF-8");// 调用下面的MD5方法得到最后的sn签名7de5a22212ffaa9e326444c75a58f9a0System.out.println(snCal.MD5(tempStr));}// 对Map内所有value作utf8编码,拼接返回结果public String toQueryString(Map<?, ?> data)throws UnsupportedEncodingException {StringBuffer queryString = new StringBuffer();for (Entry<?, ?> pair : data.entrySet()) {queryString.append(pair.getKey() + "=");queryString.append(URLEncoder.encode((String) pair.getValue(),"UTF-8") + "&");}if (queryString.length() > 0) {queryString.deleteCharAt(queryString.length() - 1);}return queryString.toString();}// 来自stackoverflow的MD5计算方法,调用了MessageDigest库函数,并把byte数组结果转换成16进制public String MD5(String md5) {try {java.security.MessageDigest md = java.security.MessageDigest.getInstance("MD5");byte[] array = md.digest(md5.getBytes());StringBuffer sb = new StringBuffer();for (int i = 0; i < array.length; ++i) {sb.append(Integer.toHexString((array[i] & 0xFF) | 0x100).substring(1, 3));}return sb.toString();} catch (java.security.NoSuchAlgorithmException e) {}return null;}}
PHP参考代码如下:
<?php//API控制台申请得到的ak(此处ak值仅供验证参考使用)$ak = 'yourak';//应用类型为for server, 请求校验方式为sn校验方式时,系统会自动生成sk,可以在应用配置-设置中选择Security Key显示进行查看(此处sk值仅供验证参考使用)$sk = 'yoursk';//以Geocoding服务为例,地理编码的请求url,参数待填$url = "http://api.map.baidu.com/geocoder/v2/?address=%s&output=%s&ak=%s&sn=%s";//get请求uri前缀$uri = '/geocoder/v2/';//地理编码的请求中address参数$address = '百度大厦';//地理编码的请求output参数$output = 'json';//构造请求串数组$querystring_arrays = array ('address' => $address,'output' => $output,'ak' => $ak);//调用sn计算函数,默认get请求$sn = caculateAKSN($ak, $sk, $uri, $querystring_arrays);//请求参数中有中文、特殊字符等需要进行urlencode,确保请求串与sn对应$target = sprintf($url, urlencode($address), $output, $ak, $sn);//输出计算得到的snecho "sn: $sn";//输出完整请求的url(仅供参考验证,故不能正常访问服务)echo "url: $target";?></syntaxhighlight><div class="separate-title">其中,caculateAKSN的定义如下:</div><syntaxhighlight lang="null">function caculateAKSN($ak, $sk, $url, $querystring_arrays, $method = 'GET'){if ($method === 'POST'){ksort($querystring_arrays);}$querystring = http_build_query($querystring_arrays);return md5(urlencode($url.'?'.$querystring.$sk));}
C#参考代码如下:
using System;using System.Collections.Generic;using System.Linq;using System.Text;public class AKSNCaculater{private static string MD5(string password){byte[] textBytes = System.Text.Encoding.UTF8.GetBytes(password);try{System.Security.Cryptography.MD5CryptoServiceProvider cryptHandler;cryptHandler = new System.Security.Cryptography.MD5CryptoServiceProvider();byte[] hash = cryptHandler.ComputeHash(textBytes);string ret = "";foreach (byte a in hash){ret += a.ToString("x2");}return ret;}catch{throw;}}private static string UrlEncode(string str){str = System.Web.HttpUtility.UrlEncode(str);byte[] buf = Encoding.ASCII.GetBytes(str);//等同于Encoding.ASCII.GetBytes(str)for (int i = 0; i < buf.Length; i++)if (buf[i] == '%'){if (buf[i + 1] >= 'a') buf[i + 1] -= 32;if (buf[i + 2] >= 'a') buf[i + 2] -= 32;i += 2;}return Encoding.ASCII.GetString(buf);//同上,等同于Encoding.ASCII.GetString(buf)}private static string HttpBuildQuery(IDictionary<string, string> querystring_arrays){StringBuilder sb = new StringBuilder();foreach (var item in querystring_arrays){sb.Append(UrlEncode(item.Key));sb.Append("=");sb.Append(UrlEncode(item.Value));sb.Append("&");}sb.Remove(sb.Length - 1, 1);return sb.ToString();}public static string CaculateAKSN(string ak, string sk, string url, IDictionary<string, string> querystring_arrays){var queryString = HttpBuildQuery(querystring_arrays);var str = UrlEncode(url + "?" + queryString + sk);return MD5(str);}}
python 2.7参考代码如下:
# -*- coding: utf-8 -*-# 第一行必须有,否则报中文字符非ascii码错误import urllibimport hashlib# 以get请求为例http://api.map.baidu.com/geocoder/v2/?address=百度大厦&output=json&ak=yourakqueryStr = '/geocoder/v2/?address=百度大厦&output=json&ak=yourak'# 对queryStr进行转码,safe内的保留字符不转换encodedStr = urllib.quote(queryStr, safe="/:=&?#+!$,;'@()*[]")# 在最后直接追加上yourskrawStr = encodedStr + 'yoursk'# md5计算出的sn值7de5a22212ffaa9e326444c75a58f9a0# 最终合法请求url是http://api.map.baidu.com/geocoder/v2/?address=百度大厦&output=json&ak=yourak&sn=7de5a22212ffaa9e326444c75a58f9a0print hashlib.md5(urllib.quote_plus(rawStr)).hexdigest()
本篇文章对您是否有帮助?