API format
Base URL
The base API url for all Binubuo endpoints is:
https://binubuo.com/api
All requests to the API, has to include a key in the header:
x-binubuo-key: {the_value_of_your_key}
API Paths
There are a number of different main paths or modules available for Binubuo calls, as listed on this page. One important thing to remember is that all paths are case sensitive and will always be lowercase.
/generator
Under the generator path is where you find all the individual generators that create the synthetic data for Binubuo. To call any of the generators, you need to know the category and the name of the generator:
https://binubuo.com/api/generator/[category_name]/[generator_name]
For a list of all the different categories and the individual generators, look at the generator reference.
/data
For custom and pre-generated datasets, you will find them all under the /data module. For standard pre-generated datasets, the path of format of the API is
https://binubuo.com/api/data/standard/[dataset_name]
Whereas for your custom datasets, the format is the following:
https://binubuo.com/api/data/custom/[unique_hash]/[dataset_name]
The unique_hash value can be fetched from https://binubuo.com/api/binubuo-actions/get-unique-url-path using a GET call.
/binubuo-actions
For direct actions for the Binubuo functionalities, you can use the binubuo-actions module. All calss are made with the following format:
https://binubuo.com/api/binubuo-actions/[action-name]