Skip to content

Getting started for back-end providers

As a back-end provider who wants to provide its datasets, processes and infrastructure to a broader audience through a standardized interface you may want to implement a driver for openEO.

First of all, you should go through the list of openEO repositories and check whether there is already a back-end driver that suits your needs. In this case you don't need to develop your own driver, but "only" need to ingest your data, adopt your required processes and set-up the infrastructure. Please follow the documentation for the individual driver you want to use.

If your preferred technology has no back-end driver yet, you may consider writing your own driver. All software written for openEO should follow the software development guidelines.

You certainly need to understand the architecture of openEO and concepts behind jobs, processes and process graphs. This helps you read and understand the API specification. Technical API related documents like CORS and error handing should be read, too.

If you do not want to start from scratch, you could try to generate a server stub from the OpenAPI 3.0-based API specification with the Swagger code generator. If you are using Python or NodeJS to implement your driver you may re-use some common modules of existing driver implementations:

You can implement a back-end in iterations. It is recommended to start by implementing the Capabilities microservice. EO Data Discovery, Process Discovery are important for the client libraries to be available, too. Afterwards you should implement Job Management or synchronous data processing. All other microservices can be added later and are not strictly required to run openEO services. Keep in mind that you don't need to implement all endpoints in the first iteration and that you can specify in the Capabilities, which endpoints you are supporting.

For example, you could start by implementing the following endpoints in the first iteration:

  • Capabilities: GET / and GET /output_formats
  • Data discovery: GET /collections and GET /collections/{name}
  • Process discovery: GET /processes
  • Data processing: POST /preview
  • Authentication (if required): GET /credentials/basic

Afterwards you can already start experimenting with your first process graphs and process EO data with our client libraries on your back-end.

More information will follow soon, for example about back-end compliance testing.