Overview

All communication between Vizydrop and connected applications occurs over a REST API. All third party applications are expected to adhere to a particular API format as outlined in this documentation. The underlying technologies used to develop these third party applications are up to the individual developer.

REST Endpoints

Below are a list of the HTTP endpoints expected in a Vizydrop connector.

Required:

Optional:

  • POST /datalist: returns possible options for filter fields
  • GET /logo: returns an image/svg+xml representation of the application's logo
  • GET /oauth1: begins OAuth (v1) authentication by retrieving redirect URI
  • POST /oauth1: finalizes OAuth (v1) authentication by processing token request
  • GET /oauth2: begins OAuth (v2) authentication by retrieving redirect URI
  • POST /oauth2: finalizes OAuth (v2) authentication by processing token request
  • POST /schema: returns predefined data schema for specified account and filter
  • POST /validate/filter: performs filter fields validation
  • POST /count: returns dataset size