This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo_cloud_maps_wms [2019/03/11 08:13] johnnyz [Samples] |
thinkgeo_cloud_maps_wms [2019/03/31 16:38] (current) brianr [Related Links] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo Cloud Maps WMS ====== | ====== ThinkGeo Cloud Maps WMS ====== | ||
- | ThinkGeo Cloud Maps WMS provides a RESTful API to get map images through WMS (Web Map Service). | + | ThinkGeo Cloud Maps WMS provides an API with which you can retrieve map images through a standards-compliant WMS (Web Map Service). This can be either a single image of a complete map, or one tile from a multi-tile map. |
- | ===== RESTful APIs===== | + | |
+ | ===== APIs ===== | ||
* //**Try it Online**:// All the ThinkGeo Cloud RESTful APIs can be tested online following the instructions below: | * //**Try it Online**:// All the ThinkGeo Cloud RESTful APIs can be tested online following the instructions below: | ||
Line 8: | Line 9: | ||
* Visit our [[https://cloud.thinkgeo.com/help/|ThinkGeo Cloud API Explorer]], click the "Authorize" button at the top and enter your client credentials. You are then free to play with all the APIs online. | * Visit our [[https://cloud.thinkgeo.com/help/|ThinkGeo Cloud API Explorer]], click the "Authorize" button at the top and enter your client credentials. You are then free to play with all the APIs online. | ||
- | //**ThinkGeo Cloud Geocoding provides the following RESTful API**:// | + | //**ThinkGeo Cloud Maps WMS provides the following RESTful API**:// |
- | ==== Get Wms Map ==== | + | ==== Get WMS Map ==== |
- | Consume the map tiles via Wms. | + | Retrieve a map image via WMS. |
<code html> | <code html> | ||
Line 19: | Line 20: | ||
//**URL Parameters**// | //**URL Parameters**// | ||
- | * //**Request**//: __Requried__. The type of the request. Acceptable values are "GetMap", "GetCapabilities". | + | * <html><span class="api-parameter"><span class="api-parameter-name">Request:</span> <em>Required.</em> The type of WMS request. Supported values are:</span></html> |
- | * //**Service**//: __Requried__. The service name. Must be "WMS". **Default value: WMS** | + | * <html><span class="api-parameter"><span class="api-parameter-name">GetMap:</span> Requests a map image. This will be the request type you use most often.</span></html> |
- | * //**Version**//: __Requried__. The version of the WMS. Now, it supports “1.1.1” and "1.3.0". **Default value: 1.1.1** | + | * <html><span class="api-parameter"><span class="api-parameter-name">GetCapabilities:</span> Details the capabilities of the WMS service.</span></html> |
- | * //**Layers**//: __Required for "GetMap"__. The layers of the requested image. Use “,” as the separator for the multiply layers. | + | * <html><span class="api-parameter"><span class="api-parameter-name">Service:</span> <em>Required.</em> The service name. Must be "WMS". <strong>Default value: WMS</strong></span></html> |
- | * //**Styles**//: __Required for "GetMap"__. The styles of the requested image. Use “,” as the separator for the multiply styles. | + | * <html><span class="api-parameter"><span class="api-parameter-name">Version:</span> <em>Required.</em> The WMS version to use. Supported values are “1.1.1” and "1.3.0". <strong>Default value: 1.1.1</strong></span></html> |
- | * //**Format**//: __Required for "GetMap"__. The format of the requested image. | + | * <html><span class="api-parameter"><span class="api-parameter-name">Layers:</span> <em>Required for "GetMap".</em> The map layers to include in the requested image. Use “,” as the separator for multiple layers. For a list of supported values, please send a “GetCapablities” request.</span></html> |
- | * //**Width**//: __Required for "GetMap"__. The width of reqeusted image in pixels. **Default value: 512** | + | * <html><span class="api-parameter"><span class="api-parameter-name">Styles:</span> <em>Required for "GetMap".</em> The styles for the requested image. Use “,” as the separator for multiple styles. For a list of supported values, please send a “GetCapablities” request.</span></html> |
- | * //**Height**//: __Required for "GetMap"__. The height of the requested image in pixels. **Default value: 512** | + | * <html><span class="api-parameter"><span class="api-parameter-name">Format:</span> <em>Required for "GetMap".</em> The format of the requested image. For a list of supported values, please send a “GetCapablities” request.</span></html> |
- | * //**Srs**//: __Required for "GetMap"__. The coordinate refrenence system in which the BBox is specified. It is used in version "1.1.1". **Default value: EPSG:3857** | + | * <html><span class="api-parameter"><span class="api-parameter-name">Width:</span> <em>Required for "GetMap".</em> The width of the requested image in pixels. <strong>Default value: 512</strong></span></html> |
- | * //**Crs**//: __Required for "GetMap"__. The coordinate refrenence system in which the BBox is specified. It is used in version "1.3.0". | + | * <html><span class="api-parameter"><span class="api-parameter-name">Height:</span> <em>Required for "GetMap".</em> The height of the requested image in pixels. <strong>Default value: 512</strong></span></html> |
- | * //**BBox**//: __Required for "GetMap"__. The bounding box of the requested image. The valid format is "minX,minY,maxX,maxY". | + | * <html><span class="api-parameter"><span class="api-parameter-name">BBox:</span> <em>Required for "GetMap".</em> The bounding box of the requested image, expressed as the spatial coordinates of a rectangle. The required format is "minX,minY,maxX,maxY".</span></html> |
- | * //**Exceptions**//: The output format of the exception. | + | * <html><span class="api-parameter"><span class="api-parameter-name">Srs:</span> <em>Required for "GetMap".</em> The spatial reference system in which the BBox is specified. Applies only to version "1.1.1". <strong>Default value: EPSG:3857</strong></span></html> |
- | * //**Transparent**//: Indicates whether the requested image should have an alpha channel. | + | * <html><span class="api-parameter"><span class="api-parameter-name">Crs:</span> <em>Required for "GetMap".</em> The coordinate reference system in which the BBox is specified. Applies only to version "1.3.0".</span></html> |
+ | * <html><span class="api-parameter"><span class="api-parameter-name">Exceptions:</span> The output format to use for exceptions.</span></html> | ||
+ | * <html><span class="api-parameter"><span class="api-parameter-name">Transparent:</span> Indicates whether or not the requested image should have an alpha channel (transparent background).</span></html> | ||
Visit [[https://cloud.thinkgeo.com/help/#/MapsWms/GetWmsMapV1|GetWmsMap]] and click "Try It Out" to explore this API online. | Visit [[https://cloud.thinkgeo.com/help/#/MapsWms/GetWmsMapV1|GetWmsMap]] and click "Try It Out" to explore this API online. | ||
===== Consume from Client Side===== | ===== Consume from Client Side===== | ||
- | ThinkGeo Cloud Projection does not allow anonymous users to access the API. Before working with these APIs, you will need to register with ThinkGeo Cloud and create your own clients. A new account comes with two clients: **NativeConfidential** and **JavaScript**. See more details at [[thinkgeo_cloud_client_keys_guideline|here]]. | ||
- | |||
ThinkGeo Cloud provides standard RESTful APIs which can be consumed on any platform through any language. ThinkGeo also offers two prepackaged API clients to make it easier to integrate into .NET and JavaScript applications. | ThinkGeo Cloud provides standard RESTful APIs which can be consumed on any platform through any language. ThinkGeo also offers two prepackaged API clients to make it easier to integrate into .NET and JavaScript applications. | ||
==== SDK for .NET ==== | ==== SDK for .NET ==== | ||
- | The SDK for .NET enables developers to build .NET applications that use the ThinkGeo Cloud services. The NuGet package can be found at [[https://www.nuget.org/packages/ThinkGeo.Cloud.Client|ThinkGeo.Cloud.Client]] or you can install this package with PM by running the command: ''Install-Package ThinkGeo.Cloud.Client -Version VERSION_TO_BE_INSTALLED'', also you can check out the [[https://github.com/ThinkGeo?utf8=%E2%9C%93&q=cloud&type=&language=|ThinkGeoCloudSample]] for the start. | + | Our .NET SDK //ThinkGeo Cloud Client// makes it easy to consume all of the ThinkGeo Cloud services in your applications. It's available on [[https://www.nuget.org/packages/ThinkGeo.Cloud.Client|NuGet]]. IntelliSense hints will help you get started, and you can also refer to the [[thinkgeo_cloud_.net_client_apis|ThinkGeo Cloud Client API list]] for details. |
+ | |||
+ | At the NuGet Package Manager terminal, you can install this package by running the command: ''Install-Package ThinkGeo.Cloud.Client -Version VERSION_TO_BE_INSTALLED''. You can also check out ThinkGeo on GitHub for [[https://github.com/ThinkGeo?utf8=%E2%9C%93&q=cloud&type=&language=|samples utilizing the ThinkGeo Cloud Client]]. | ||
==== SDK for JavaScript ==== | ==== SDK for JavaScript ==== | ||
Line 87: | Line 90: | ||
* [[thinkgeo_cloud_projection|ThinkGeo Cloud Projection]] | * [[thinkgeo_cloud_projection|ThinkGeo Cloud Projection]] | ||
* [[thinkgeo_cloud_colors|ThinkGeo Cloud Colors]] | * [[thinkgeo_cloud_colors|ThinkGeo Cloud Colors]] | ||
+ | * [[thinkgeo_cloud_timezone|ThinkGeo Cloud Time Zones]] | ||