| 承载协议 | HTTPS GET |
|---|---|
| 接口方向 | 开发者服务器 -> 华为地图服务器 |
| 接口URL | https://mapapi.cloud.huawei.com/mapApi/v1/mapService/getStaticMap |
| 数据格式 | 响应消息:Content-Type: image/png |
Request Header中的Authorization和Query String中的key至少需要存在一个。
Request Header
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | application/json | 请求消息的数据格式。 |
| Authorization | 否 | String | AT或者API Key,推荐用AT。 说明: |
Query String
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 否 | String | 鉴权密钥,申请参见获取API密钥。 说明:
|
| width | 是 | Integer | 图片宽度。 取值范围:(0, 1024]。 |
| height | 是 | Integer | 图片高度。 取值范围:(0, 1024]。 |
| location | 否 | String | 地址信息,支持经纬度、地址。经纬度采用逗号分隔,经纬度格式是:latitude,longitude,例如:41.43206,-81.38992,如无markers/path则是必选。 |
| zoom | 否 | int | 缩放级别,如无markers/path则是必选。取值范围:[1, 18]。 |
| scale | 否 | Integer | 清晰度比较尺。默认值为1,有效值为1和2。 |
| pattern | 否 | String | 图片格式,当前只支持PNG。 |
| mapType | 否 | String | 标准roadmap,当前暂只支持标准roadmap。 |
| language | 否 | String | 图片显示语种,语言编码支持ISO 639-2 Code和BCP47。推荐使用BCP47,取值范围参见支持的语言。 |
| markers | 否 | String | marker描述信息,支持Marker样式、经纬度或地址,支持输入多组位置信息,通过|分开。 markers=Marker样式|{纬度1,经度1}|{纬度2,经度2}|地址,如果不指定Marker样式,使用markerStyles作为默认样式。 说明: markers/path和location/zoom至少需要输入一组。如果都存在,以location/zoom为主。 |
| markerStyles | 否 | String | marker样式描述信息,可指定的属性包括:
参考样例: size:mid|color:black|label:C|icon:https%253A%252F%252Fwww-file.huawei.com%252F-%252Fmedia%252Fcorporate%252Fimages%252Fhome%252Flogo%252Fhuawei_logo.png。 说明:
|
| path | 否 | String | Path描述信息,支持Path样式、经纬度或地址,支持输入多组位置信息,通过|分开。 path=Path样式|{纬度1,经度1}|{纬度2,经度2}|地址,如果不指定Path样式,使用pathStyles作为默认样式。 说明: markers/path和location/zoom至少需要输入一组。如果都存在,以location/zoom为主。 |
| pathStyles | 否 | String | path样式描述信息,可指定的属性包括:
如果有fillcolor,表示path是多边形,否则是折线。 参考样例:color:0x0000ff80|weight:1|fillcolor:0x0000ff80。 |
| logo | 否 | String | logo样式描述信息,可指定属性包括logoAnchor、visible。
参考样例:logoAnchor:bottomleft|visible:true。 |
| signature | 否 | String | 签名,通过签名密钥加密生成的消息签名。推荐使用该签名功能,与API密钥联合控制保证接口安全性。 说明: 获取签名密钥的方式请参见获取签名密钥。 |
| presetStyleId | 否 | String | 支持设置地图预置样式,可指定的属性包括:
|
GET https://mapapi.cloud.huawei.com/mapApi/v1/mapService/getStaticMap? width=1024& height=512& location=41.43206,-81.38992& scale=1& zoom=5& language=en& logo=logoAnchor:bottomleft& markers={41.43206,-81.38992}& markers={43.43206,-85.38992}& markerStyles=size:tiny|color:blue|label:p& path={41.43206,-81.38992}|{43.43206,-85.38992}& path=fillcolor:red|{41.43206,-81.38992}|{43.43206,-85.38992}|{39.43206,-83.38992}& pathStyles=weight:1|color:0x0000ff80|fillcolor:0x0000ff80& key=xxx& signature=xxx
转义后:
GET https://mapapi.cloud.huawei.com/mapApi/v1/mapService/getStaticMap? width=1024& height=512& location=41.43206,-81.38992& scale=1& zoom=5& language=en& logo=logoAnchor:bottomleft& markers=%7B41.43206,-81.38992%7D& markers=%7B43.43206,-85.38992%7D& markerStyles=size:tiny%7Ccolor:blue%7Clabel:p& path=%7B41.43206,-81.38992%7D%7C%7B43.43206,-85.38992%7D& path=fillcolor:red%7C%7B41.43206,-81.38992%7D%7C%7B43.43206,-85.38992%7D%7C%7B39.43206,-83.38992%7D& pathStyles=weight:1%7Ccolor:0x0000ff80%7Cfillcolor:0x0000ff80& key=xxx& signature=xxx
请求时需要对符号进行转义,’|‘符号转义为%7C,’{‘ 符号转义为%7B,’}‘ 符号转义为%7D。
状态码为200时:
Response Header
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | image/png | 响应消息的数据格式。 |
Response Body
| 参数 | 参数类型 | 描述 |
|---|---|---|
| Body | String | 静态图。 |
“AT认证” public class GetStaticMapService { OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://mapapi.cloud.huawei.com/mapApi/v1/mapService/getStaticMap?" + // 设置返回图片宽度为1024 "width=1024&" + // 设置返回图片高度为512 "height=512&" + // 地址信息,纬度:41.43206,经度:-81.38992 "location=41.43206%2C-81.38992&" + // 设置清晰度比较尺为1 "scale=1&" + // 设置缩放级别为5 "zoom=5&" + // 设置图片格式:png "pattern=PNG&" + // 设置图片显示的语言为英语 "language=en&" + // logo样式描述 "logo=logoAnchor%3Abottomleft&" + // maker描述信息,纬度:41.43206,经度:-81.38992 "markers=%7B41.43206%2C-81.38992%7D&" + // maker描述信息,纬度:43.43206,经度:-85.38992 "markers=%7B43.43206%2C-85.38992%7D&" + // maker样式描述信息 "markerStyles=size%3Atiny%7Ccolor%3Ablue%7Clabel%3Amjy&" + // path描述信息,{纬度,经度}:{41.43206,-81.38992}|{43.43206,-85.38992} "path=%7B41.43206%2C-81.38992%7D%7C%7B43.43206%2C-85.38992%7D&" + // path描述信息,样式为红色,{纬度,经度}:{41.43206,-81.38992}|{43.43206,-85.38992}|{39.43206,-83.38992} "path=fillcolor%3Ared%7C%7B41.43206%2C-81.38992%7D%7C%7B43.43206%2C-85.38992%7D%7C%7B39.43206%2C-83.38992%7D&" + // path样式描述信息 "pathStyles=weight%3A1%7Ccolor%3A0x0000ff80%7Cfillcolor%3A0x0000ff80&") .addHeader("Authorization", "Bearer " + AT) .get() .build(); Response response = client.newCall(request).execute(); }
“API KEY认证” public class GetStaticMapService { OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://mapapi.cloud.huawei.com/mapApi/v1/mapService/getStaticMap?" + // 设置返回图片宽度为1024 "width=1024&" + // 设置返回图片高度为512 "height=512&" + // 地址信息,纬度:41.43206,经度:-81.38992 "location=41.43206%2C-81.38992&" + // 设置清晰度比较尺为1 "scale=1&" + // 设置缩放级别为5 "zoom=5&" + // 设置图片格式:png "pattern=PNG&" + // 设置图片显示的语言为英语 "language=en&" + // logo样式描述 "logo=logoAnchor%3Abottomleft&" + // maker描述信息,纬度:41.43206,经度:-81.38992 "markers=%7B41.43206%2C-81.38992%7D&" + // maker描述信息,纬度:43.43206,经度:-85.38992 "markers=%7B43.43206%2C-85.38992%7D&" + // maker样式描述信息 "markerStyles=size%3Atiny%7Ccolor%3Ablue%7Clabel%3Amjy&" + // path描述信息,{纬度,经度}:{41.43206,-81.38992}|{43.43206,-85.38992} "path=%7B41.43206%2C-81.38992%7D%7C%7B43.43206%2C-85.38992%7D&" + // path描述信息,样式为红色,{纬度,经度}:{41.43206,-81.38992}|{43.43206,-85.38992}|{39.43206,-83.38992} "path=fillcolor%3Ared%7C%7B41.43206%2C-81.38992%7D%7C%7B43.43206%2C-85.38992%7D%7C%7B39.43206%2C-83.38992%7D&" + // path样式描述信息 "pathStyles=weight%3A1%7Ccolor%3A0x0000ff80%7Cfillcolor%3A0x0000ff80&" + "key=xxxx") .get() .build(); Response response = client.newCall(request).execute(); }
“AT认证” import java.io.IOException; import java.io.UnsupportedEncodingException; import java.net.MalformedURLException; import java.net.URL; import java.net.URLDecoder; import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Paths; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.util.ArrayList; import java.util.Base64; import java.util.List; import java.util.SortedMap; import java.util.TreeMap; import javax.crypto.Mac; import javax.crypto.SecretKey; import javax.crypto.spec.SecretKeySpec; import okhttp3.HttpUrl; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; public class Demo { public static void main(String[] args) throws Exception { new Demo().getStaticMapWithUrlSignature(); } private void getStaticMapWithUrlSignature() throws NoSuchAlgorithmException, InvalidKeyException, IOException { OkHttpClient client = new OkHttpClient(); HttpUrl httpUrl = new HttpUrl.Builder().scheme("https") .host("mapapi.cloud.huawei.com") .encodedPath("/mapApi/v1/mapService/getStaticMap") // 设置返回图片宽度为1024 .addQueryParameter("width", "1024") // 设置返回图片高度为512 .addQueryParameter("height", "512") // 地址信息,纬度:41.43206,经度:-81.38992 .addQueryParameter("location", "41.43206,-81.38992") // 设置清晰度比较尺为1 .addQueryParameter("scale", "1") // 设置缩放级别为5 .addQueryParameter("zoom", "5") // 设置图片显示的语言为英语 .addQueryParameter("language", "en") // logo样式描述 .addQueryParameter("logo", "logoAnchor:bottomleft") // maker描述信息,纬度:41.43206,经度:-81.38992 .addQueryParameter("markers", "{41.43206,-81.38992}") // maker描述信息,纬度:43.43206,经度:-85.38992 .addQueryParameter("markers", "{43.43206,-85.38992}") // maker样式描述信息 .addQueryParameter("markerStyles", "size:tiny|color:blue|label:p") // path描述信息,{纬度,经度}:{41.43206,-81.38992}|{43.43206,-85.38992} .addQueryParameter("path", "{41.43206,-81.38992}|{43.43206,-85.38992}") // path描述信息,样式为红色,{纬度,经度}:{41.43206,-81.38992}|{43.43206,-85.38992}|{39.43206,-83.38992} .addQueryParameter("path", "fillcolor:red|{41.43206,-81.38992}|{43.43206,-85.38992}|{39.43206,-83.38992}") // path样式描述信息 .addQueryParameter("pathStyles", "weight:1|color:0x0000ff80|fillcolor:0x0000ff80") .build(); String urlToSign = httpUrl.toString(); // 签名密钥 String secret = "xxx"; String signature = sign(urlToSign, secret); String url = urlToSign + "&signature=" + signature; Request request = new Request.Builder().url(ROOT_URL).addHeader("Authorization", "Bearer " + AT) .get() .build(); Response response = client.newCall(request).execute(); // 响应处理... } private String sign(String urlToSign, String secret) throws MalformedURLException, NoSuchAlgorithmException, InvalidKeyException { URL url = new URL(urlToSign); String canonicalUrl = url.getPath() + "?" + new CanonicalQueryString(url.getQuery()).toString(); SecretKey secretKey = new SecretKeySpec(secret.getBytes(StandardCharsets.UTF_8), "HmacSHA256"); Mac mac = Mac.getInstance("HmacSHA256"); mac.init(secretKey); byte[] sigBytes = mac.doFinal(canonicalUrl.getBytes()); String signature = Base64.getEncoder().encodeToString(sigBytes); signature = signature.replace('+', '-'); signature = signature.replace('/', '_'); return signature; } static class CanonicalQueryString { private static final int INIT_BUFFER_SIZE = 128; /** * The constant PARAMETER_EQ. */ public static final String PARAMETER_EQ = "="; /** * The constant PARAMETER_SEP. */ public static final String PARAMETER_SEP = "&"; private SortedMap<String, List<String>> params = new TreeMap<>(); /** * Instantiates a new Canonical query string. * * @param queryString the query string */ public CanonicalQueryString(String queryString) { if (queryString == null || queryString.length() == 0) { return; } for (String pair : queryString.split(PARAMETER_SEP)) { int idx = pair.indexOf(PARAMETER_EQ); if (idx != -1) { String value = pair.substring(idx + 1); if (value == null || value.length() == 0) { continue; } String paramKey = pair.substring(0, idx); List<String> values = params.computeIfAbsent(paramKey, key -> new ArrayList<>()); try { values.add(URLDecoder.decode(value, "UTF-8")); } catch (UnsupportedEncodingException e) { // ignore } } } } @Override public String toString() { StringBuilder sb = new StringBuilder(INIT_BUFFER_SIZE); for (SortedMap.Entry<String, List<String>> item : params.entrySet()) { String key = item.getKey(); for (String value : item.getValue()) { if (sb.length() > 0) { sb.append(PARAMETER_SEP); } sb.append(key).append(PARAMETER_EQ).append(value); } } return sb.toString(); } } }
“API KEY认证” import java.io.IOException; import java.io.UnsupportedEncodingException; import java.net.MalformedURLException; import java.net.URL; import java.net.URLDecoder; import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Paths; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.util.ArrayList; import java.util.Base64; import java.util.List; import java.util.SortedMap; import java.util.TreeMap; import javax.crypto.Mac; import javax.crypto.SecretKey; import javax.crypto.spec.SecretKeySpec; import okhttp3.HttpUrl; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; public class Demo { public static void main(String[] args) throws Exception { new Demo().getStaticMapWithUrlSignature(); } private void getStaticMapWithUrlSignature() throws NoSuchAlgorithmException, InvalidKeyException, IOException { OkHttpClient client = new OkHttpClient(); HttpUrl httpUrl = new HttpUrl.Builder().scheme("https") .host("mapapi.cloud.huawei.com") .encodedPath("/mapApi/v1/mapService/getStaticMap") // 设置返回图片宽度为1024 .addQueryParameter("width", "1024") // 设置返回图片高度为512 .addQueryParameter("height", "512") // 地址信息,纬度:41.43206,经度:-81.38992 .addQueryParameter("location", "41.43206,-81.38992") // 设置清晰度比较尺为1 .addQueryParameter("scale", "1") // 设置缩放级别为5 .addQueryParameter("zoom", "5") // 设置图片显示的语言为英语 .addQueryParameter("language", "en") // logo样式描述 .addQueryParameter("logo", "logoAnchor:bottomleft") // maker描述信息,纬度:41.43206,经度:-81.38992 .addQueryParameter("markers", "{41.43206,-81.38992}") // maker描述信息,纬度:43.43206,经度:-85.38992 .addQueryParameter("markers", "{43.43206,-85.38992}") // maker样式描述信息 .addQueryParameter("markerStyles", "size:tiny|color:blue|label:p") // path描述信息,{纬度,经度}:{41.43206,-81.38992}|{43.43206,-85.38992} .addQueryParameter("path", "{41.43206,-81.38992}|{43.43206,-85.38992}") // path描述信息,样式为红色,{纬度,经度}:{41.43206,-81.38992}|{43.43206,-85.38992}|{39.43206,-83.38992} .addQueryParameter("path", "fillcolor:red|{41.43206,-81.38992}|{43.43206,-85.38992}|{39.43206,-83.38992}") // path样式描述信息 .addQueryParameter("pathStyles", "weight:1|color:0x0000ff80|fillcolor:0x0000ff80") .build(); String urlToSign = httpUrl.toString(); // 签名密钥 String secret = "xxx"; String signature = sign(urlToSign, secret); // URLEncoder.encode编码后的API密钥 String encodedApiKey = "xxx"; String url = urlToSign + "&key=" + encodedApiKey + "&signature=" + signature; Request request = new Request.Builder().url(url).get().build(); Response response = client.newCall(request).execute(); // 响应处理... } private String sign(String urlToSign, String secret) throws MalformedURLException, NoSuchAlgorithmException, InvalidKeyException { URL url = new URL(urlToSign); String canonicalUrl = url.getPath() + "?" + new CanonicalQueryString(url.getQuery()).toString(); SecretKey secretKey = new SecretKeySpec(secret.getBytes(StandardCharsets.UTF_8), "HmacSHA256"); Mac mac = Mac.getInstance("HmacSHA256"); mac.init(secretKey); byte[] sigBytes = mac.doFinal(canonicalUrl.getBytes()); String signature = Base64.getEncoder().encodeToString(sigBytes); signature = signature.replace('+', '-'); signature = signature.replace('/', '_'); return signature; } static class CanonicalQueryString { private static final int INIT_BUFFER_SIZE = 128; /** * The constant PARAMETER_EQ. */ public static final String PARAMETER_EQ = "="; /** * The constant PARAMETER_SEP. */ public static final String PARAMETER_SEP = "&"; private SortedMap<String, List<String>> params = new TreeMap<>(); /** * Instantiates a new Canonical query string. * * @param queryString the query string */ public CanonicalQueryString(String queryString) { if (queryString == null || queryString.length() == 0) { return; } for (String pair : queryString.split(PARAMETER_SEP)) { int idx = pair.indexOf(PARAMETER_EQ); if (idx != -1) { String value = pair.substring(idx + 1); if (value == null || value.length() == 0) { continue; } String paramKey = pair.substring(0, idx); List<String> values = params.computeIfAbsent(paramKey, key -> new ArrayList<>()); try { values.add(URLDecoder.decode(value, "UTF-8")); } catch (UnsupportedEncodingException e) { // ignore } } } } @Override public String toString() { StringBuilder sb = new StringBuilder(INIT_BUFFER_SIZE); for (SortedMap.Entry<String, List<String>> item : params.entrySet()) { String key = item.getKey(); for (String value : item.getValue()) { if (sb.length() > 0) { sb.append(PARAMETER_SEP); } sb.append(key).append(PARAMETER_EQ).append(value); } } return sb.toString(); } } }