Keboola Connection (KBC) is an open system of many components orchestrated together through (mostly REST) APIs. Although quite complex, it is modular and therefore you rarely need to work with more than a few components.
The following chart shows how KBC is structured. All KBC parts are briefly described here.
Everything you can do in the KBC UI can be done programatically using the API of the corresponding component. All of our components have API documentation on Apiary and most of them have a public Github repository. Our Docker components are built either on DockerHub, Quay or privately on AWS ECR.
This means that there are virtually endless possibilities of what can be done with KBC programmatically.
There are some components which are probably more important than others:
All components share some common behaviour such as Component Configuration Running Jobs, which allows each component to be run in Orchestrations. This means that once worked your way through one component, you have seen them all. Most of our components are open source. If you are interested in their code, have a look at our repositories. Apart from that common features, some components define additional synchronous actions. This (and many other information) can be retrieved using the Developer Portal API (specifically the Get app detail call which lists all components available in KBC.
What each component does is defined purely by that component, and so is the content of the configuration.
Each component has a
/run API call that accepts either a reference to component configuration
config field) or full component configuration (
configData field) in JSON body, and
queues an asynchronous job.
For more details, see full API description.
Configuration can be defined with a JSON schema stored within the Component detail. Docker Components without their own schemas can use a generic Docker Component schema.
Apart from the above common API, some components offer other API calls: