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&paramName2=paramValue2&paramName3=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