Seamlines WMS
Overview
The Web Map Service (WMS) returns a raster representation of lines for a given area, based on request parameters.
Authentication
All OGC services accept an API key or a bearer token for authentication.
Bearer tokens
Oauth bearer tokens can also be used to authenticate API requests. Bearer tokens have a brief duration and must be refreshed frequently.
To authenticate with a bearer token, use the Authorization header:
Authorization: Bearer <Oauth2 token>
Learn about OAuth2 bearer tokens
API keys
API keys can be passed using query parameters or in a custom header. No Authorization header is needed when using API keys.
To use the query parameter method, include this query parameter in your request:
maxar_api_key=<your API key>
The custom header takes the form of:
maxar-api-key: <your API key>
API keys expire 180 days from creation by default. A custom expiration date can be set but cannot exceed 180 days.
Learn about API keys
Services
| Name | Description | Request URL |
|---|---|---|
| Get Capabilities | Describes the capabilities available for WMS. | https://api.maxar.com/basemaps/v1/seamlines/wms?request=GetCapabilities |
| Get Map (Seamlines) | Generates an image with seamlines based on the input query parameters. | https://api.maxar.com/basemaps/v1/seamlines/ows?SERVICE=WMS&REQUEST=GetMap |
WMS Get Capabilities
Returns a list of services and operations supported by WMS.
Request URL
https://api.maxar.com/basemaps/v1/seamlines/ows?SERVICE=WMS&REQUEST=GetCapabilities&VERSION=1.3.0
Query parameters
| Name | Required/Optional | Description | Value |
|---|---|---|---|
| service | required | The name of the requested OGC service. | wms |
| request | required | The name of the request type | GetCapabilities |
| version | required | The version number of the service | Use 1.3.0 |
Response
Response output format: XML
Successful status code: 200 OK
Exceptions may also return a 200 OK, with an error in the response body.
The response body is returned in XML format and describes the supported WMS services and imagery layers.
WMS Get Map Seamlines
Generates an image with seamlines based on the input query parameters.
Request URL
URL path with required parameters:
Example:
https://api.maxar.com/basemaps/v1/seamlines/ows?service=wms&request=GetMap&version=1.3.0&bbox=36.985003,-109.028320,40.996484,-102.041016&crs=EPSG:4326&layers=Maxar:seamline&height=300&width=300&format=image/jpeg&transparent=True&tiled=true&cql_filter=product_name='VIVID_STANDARD_30'
Query parameters
| Name | Required/Optional | Description | Value |
|---|---|---|---|
| service | required | The requested OGC service. | service=wms |
| request | required | The name of the WMS request type. | GetMap |
| version | required | The version number of the service. | 1.3.0 |
| bbox | required | A bounding box in ymin, xmin, ymax, xmax format.This format is required for EPSG:4326 projection in WMS v1.3.0. | 39.719534,-105.009465,39.746465,-104.957624 |
| layers | required | The name of the imagery layer to query. | Maxar:seamline |
| crs | required | The requested output projection. The CRS value must be supported by the layer. | EPSG:4326 |
| height | required | The height of the vertical tile column | Example: 512 |
| width | required | The width of the horizontal tile row | Example: 512 |
| format | optional | The output file format of the response. | image/vnd.jpeg-png |
| transparent | optional | Removes blank background space from returned images. | true |
| styles | optional | Renders the layers in the selected style. | raster. |
| tiled | optional | Clips returned image by the tile boundaries | true |