Overview

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

REST Endpoints

Below are a list of the HTTP endpoints expected in an integration application.

Required:

• GET /: returns app information
• POST /validate: performs validation of the account
• POST /api/v1/synchronizer/config: returns synchronizer configuration
• POST /api/v1/synchronizer/schema: returns synchronizer schema
• POST /api/v1/synchronizer/data: returns data

Optional (General):

• GET /logo: returns an image/svg+xml representation of the application's logo

Optional (Synchronizer):

• POST /api/v1/synchronizer/datalist: returns possible options for filter fields
• POST /api/v1/synchronizer/filter/validate: performs filter fields validation
• POST /api/v1/synchronizer/webhooks: attach webhook
• DELETE /api/v1/synchronizer/webhooks: detach webhook
• POST /api/v1/synchronizer/webhooks/verify: verify webhook event
• POST /api/v1/synchronizer/webhooks/transform : transform webhook event into data

Optional (OAuth):

• POST /oauth1/v1/authorize: begins OAuth (v1) authentication by retrieving redirect URI
• POST /oauth1/v1/access_token: finalizes OAuth (v1) authentication by processing token request
• POST /oauth2/v1/authorize: begins OAuth (v2) authentication by retrieving redirect URI
• POST /oauth2/v1/access_token: finalizes OAuth (v2) authentication by processing token request