Iris RESTful API

Welcome to the Iris RESTful API

The Iris RESTful Server and corresponding Openseadragon IrisTileSource allow for the immediate use of the Iris File Extension within existing OpenSeaDragon whole slide viewer applications. This examples.restful.irisdigitalpathology.org server domain responds natively to Iris API calls, and can be assigned as the IrisTileSource.serverUrl to immediately begin testing your viewer system with example Iris File Extension encoded slide files before deploying your own Iris RESTful Server.

For more information about the openly available (CC-BY 4.0) Iris File Extension digital slide format and how it can accelerate your digital pathology whole slide imaging workflows, see the referenced paper below.

Zoom: 100%

This is an Iris Slide File
Rendered with OpenSeaDragon

Getting Started with OpenSeaDragon and the IrisTileSource

OpenSeadragon is a dependency-free JavaScript library for viewing zoomable images. Follow the official OpenSeaDragon getting started documentation to get started.

Step 1: Create a Viewer Container

<div id="iris-viewer" style="width: 800px; height: 600px;"></div>

Important: The container must have its own width and height!

Step 2: Use our Current OpenSeaDragon Pull Request in Your Page

<script src="https://examples.restful.irisdigitalpathology.org/openseadragon/openseadragon.min.js"></script>

This will eventually be repaced with the offical OpenSeaDragon source when IrisTileSource is merged.

Step 3: Set Up the Iris TileSource

<script>
    const viewer = OpenSeadragon({id: "iris-viewer"});
    const tileSource = new OpenSeadragon.IrisTileSource({
        // Set this Iris RESTful Example Domain as the Slide Server
        serverUrl: "https://examples.restful.irisdigitalpathology.org",
        slideId: "cervix_2x_jpeg",      // For the file "cervix_2x_jpeg.iris"
        crossOriginPolicy: "Anonymous"  // Enable CORS for RESTful Example
    }); // End new code
    tileSource.addHandler('ready', function () {
        viewer.open(tileSource);
    });
</script>

Next Steps: Deploy your own Iris RESTful Server

docker run --rm -v${SLIDES_DIRECTORY}:/slides -p ${CONNECTION_PORT}:3000 ghcr.io/irisdigitalpathology/iris-restful:latest