VectorSurv API Documentation Homepage

Getting Started

The intended audience for the VectorSurv API is VectorSurv users looking to programmatically access their VectorSurv data. If this is your first time, we suggest starting by learning how to authenticate. You might also be interested in learning how to add a mosquito collection. Full documentation for this API can be found at https://api.vectorsurv.org/.

When developing on this API, utilize the Sandbox

The VectorSurv API offers access to the VectorSurv production database, as well as to the playground "Sandbox" for exploration. VectorSurv offers a "playground" environment, known as the Sandbox, where you are allowed to experiment with the various features without any risks to the real data that have been entered into the VectorSurv Gateway. Data entered or features tested within the Sandbox environment do not persist, as the Sandbox is reset each weekend to match the data in the Gateway. An Agency Token created on the Gateway will work on the Sandbox after the weekly reset.

Production request: https://api.vectorsurv.org/api/list-aliases

Sandbox request: https://sandbox.api.vectorsurv.org/api/list-aliases

A RESTful API

We use a representational state transfer (REST) architecture for simplicity and predictability. This is a commonly-used pattern that many developers have prior experience with. Here’s how Google summarizes REST in its API design guidelines:

Its core principle is to define named resources that can be manipulated using a small number of methods. The resources and methods are known as nouns and verbs of APIs. With the HTTP protocol, the resource names naturally map to URLs, and methods naturally map to HTTP methods POST, GET, PUT, PATCH, and DELETE. This results in much fewer things to learn, since developers can focus on the resources and their relationship, and assume that they have the same small number of standard methods.