Skip to content

Sapio Studies API

Welcome to the documentation for Sapio Studies API, provided by the Sanger Integration Hub, for the accession, creation, and updating of studies by the Sapio LIMS.

About this Documentation

This documentation is intended to help users understand the purpose, architecture, and usage of this project. It provides guidance on how to interact with the APIs, including authentication, request/response formats, and example use cases.

The following sections are included:

  1. Purpose and Features – Describes the purpose of the integration, the problems it solves, and its key capabilities.
  2. High Level Architecture – Provides an overview of the system architecture and how the major components interact.
  3. Authentication & Access – Explains how to obtain credentials and authenticate with the API.
  4. How to Use – Explains how users can interact with the API and perform common tasks.
  5. Example Use Cases – Demonstrates real-world scenarios and examples.

Intended Audience

This documentation is useful for: * Users of the Sapio Studies integration * Developers and engineers * Solution architects * Support and operational teams

Users will be provided with an overview of the API and what it is designed to achieve. A high-level description of the system architecture is included, but detailed technical implementation or the underlying components that support the project are not covered here.

Authentication

Users must obtain credentials from the Sanger Integration Hub to access the API endpoints.

See the Authentication & Access page for details.

Additional Information

For questions, support, or further information, please contact the Sanger Integration Hub, integration-hub@sanger.ac.uk