Plugin endpoints

1:00 min
Intro

It's important to realize that a plugin is no more than an API which fulfills a contract specified by the Luzmo team. This contract defines that there are 4 endpoints in the API.

Method
Endpoint
Description
POST
/authorize
Endpoint that is called when an account on your plugin is created.
POST
/exchange
Also related to authentication, only for OAuth.
GET
/datasets
Get information about which datasets the plugin provides. This will appear in a modal that pops up when selecting the plugin as a data source in Cumul.io.
POST
/query
Retrieve the data!

The only two endpoints that are essential for a plugin are the /datasets and /query endpoints. The other two endpoints are needed for authentication, which is covered in a later article in this course.

Previous
Next

Need more information?

Do you still have questions? Let us know how we can help.
Send us feedback!

Course Outline

Getting started
Security
Exposing your datasets
Exposing your data
Testing