Edit me

All communication between Vizydrop and connected applications occurs over a REST API, as specified and outlined in this chapter. 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

  • GET /: returns app and schema information
  • POST /: actual gathering of external source
  • POST /validate: performs validation of accounts

Optional

  • POST /datalist: gathers 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