Vexcel API Documentation
About the API
The Application Programming Interface (API) is a set of HTTPS services that allows viewing and downloading images and metadata as well as performing operations on the imagery.
These HTTPS services are defined as parameter-based REST and key/value pair protocols for requesting information. They offer responses in a wide variety of formats, including the most common image formats and JSON, JSONP, and XML formats for metadata.
Most services respond to standard HTTPS GET or POST requests, and return the information in the body of the HTTPS response.
Request Structure
The request parameter structure can be built as a key/value pair format on the request URI, as RESTful format, or both. Examples are included below.
Key/Value Pair:
http://url?paramName=paramValue¶mName2=paramValue2¶mName3=paramValue3
REST:
http://url/paramValue/paramValue2/paramValue3
Both:
http://url/paramValue/paramValue2?paramName3=paramValue3
It is recommended that URI length is kept below 2,000 characters with all services.
Response Format
The success (and error) response format depends on the service used and is returned in standard JSON like this:
{"status": statusCode,"message": statusMessage}
API Service Documents
- Administrative Services
- Authentication Token Services - v1.4 — Returns and manages authentication tokens.
- API 1.0 to 2.0 Migration Guides
- API 1.0 Tutorials and Extras
- Error Codes and Responses - v1.3 — Outlines common HTTP statuses, messages and descriptions.
- Tutorial 1: Generate an Authentication Token and download an image with ExtractImage - v1.4 — Outlines the steps required to gain a token and download a discrete image.
- Vexcel API Beginners Guide — A beginners guide to the Vexcel API services and their functionality.
- API 2.0 Tutorials and Extras
- Coverage Services
- CoverageDataInPoint Service - v1.4 — Returns the range of collection dates and ground sample distance for discrete images intersecting the input point.
- DSMCoverage Service - v1.4 — Returns a metadata file containing the geographic extents of intersecting DSM-containing AOIs.
- DTMCoverage Service - v1.4 — Returns a metadata file containing geographic extents of intersecting DTM-containing AOIs.
- FindImage Service - v1.4 — Returns a metadata file containing the discrete image with the best coverage of the input point.
- FindImagesInPoint Service - v1.4 — Returns a metadata file containing all discrete images intersecting the input point.
- FindImagesInPolygon Service - v1.4 — Returns a metadata file containing all discrete images intersecting the input polygon.
- GetCoverageInfo Service - v1.4 — Returns a metadata file with information about the coverage over a location.
- ImageLayerCoverage Service - v1.4 — Returns a metadata file containing the geographic extents of input AOIs or Layers.
- OrthoCoverage Service - v1.4 — Returns a metadata file containing the geographic extents of ortho imagery.
- Discrete and Static Imagery Services
- ExtractImages Service - v1.4 — Returns one or more discrete RGB images.
- ExtractNIRImages Service - v1.4 — Returns one or more discrete NIR images.
- ExtractOrthoImages - v1.4 — Returns a seamless image cut from the orthomosaic layer.
- GetImage Service - v1.4 — Returns a discrete image with the requested zoom and size requirements.
- Elements Services
- DamageReport - v1.4 — Returns a formatted report containing Gray Sky and Blue Sky imagery and damage attributes for a property.
- GetPropertyDamage - v1.4 — Returns a metadata file for a single building with post-catastrophic attributes pertaining to structure damage.
- GetPropertyInformation - v1.4 — Returns a metadata file for a single property parcel with attributes including building footprint(s).
- PropertyReport - v1.4 — Returns a formatted report containing Blue Sky imagery and attributes for a property.
- Metadata Services
- Discrete Images Metadata - v1.3 — Outlines the metadata parameters and descriptions for discrete images.
- FindImages Service - v1.4 — Returns a metadata file containing information about one or more discrete images.
- ImageMetadata Service - v1.4 — Returns a metadata file with information about one discrete image.
- OrthoEstimateDates - v1.4 — Returns the minimum, maximum and estimated collection dates for a given point.
- TransformDiscretePoints Service - v1.4
- Tile Services
- GetDSMTile Service - v1.4 — Returns one DSM tile.
- GetDTMTile Service - v1.4 — Returns one DTM tile.
- GetImageTile Service - v1.3 — Returns one image tile derived from discrete imagery.
- GetOrthoImageTile Service - v1.4 — Returns one orthomosaic tile.
- WebMapTileService (WMTS) - v1.4 — Returns one orthomosaic tile using the WMTS protocol.
Need help? Create a support ticket | support@vexcelgroup.com
Need help? Create a support ticket | support@vexcelgroup.com