Skip to content

Partners and Developers: Start Here

This section is for people who want to integrate the ELIXIR On-Cloud deployment or its components with their own solutions.

What these docs cover

These docs cover the ELIXIR On-Cloud sandbox/demo deployment, how to integrate with it, and tutorials, for node operators, partners and developers, and researchers. Generic instructions for installing and using the individual products are in each product's own docs, linked from here.

What you can integrate

  • The deployment's APIs. The stack implements the GA4GH APIs for workflows (WES), tasks (TES), data (DRS), tools (TRS) and services (Service Registry). Clients use these APIs as GA4GH defines them.
  • LS Login. It is the identity provider of the deployment. Your app or script gets an access token from it to call the services.
  • The packages behind the services. You can reuse FOCA, foca-plugins and Cloud Components in your own services and web apps.

Follow these steps

  1. Read GA4GH Standards to see which API versions the stack implements and which workflow engines can use them.
  2. Follow Using the APIs to find the services of the deployment, get an access token from LS Login and send a request.
  3. Read Packages if you want to build your own service or front end with the same tools.
  4. Contribute your changes.

Working with sensitive data, or planning how users reach your service? See Sensitive Data and User Stories.

Contribute

All repositories of the ELIXIR On-Cloud GitHub organization share one contributing guide. It covers the workflow, the code of conduct and the security policy. The docs of each package add the steps for its code. See the "Contributing" page of FOCA, foca-plugins, Cloud Registry and Cloud Components.

For questions and ideas, use the Discussions. More ways to get in touch are on the About page.