72 lines
2.6 KiB
HTML
72 lines
2.6 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head><title>inou API Documentation</title></head>
|
|
<body>
|
|
<h1>inou Health Dossier API</h1>
|
|
|
|
<h2>Authentication</h2>
|
|
<p>All endpoints require a <code>token</code> query parameter - your authentication token (dossier GUID).</p>
|
|
|
|
<h2>Base URL</h2>
|
|
<p>https://inou.com</p>
|
|
|
|
<h2>Endpoints</h2>
|
|
|
|
<h3>GET /api/dossiers</h3>
|
|
<p>List all patient dossiers accessible to this account.</p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<ul>
|
|
<li>token (required) - Your authentication token</li>
|
|
<li>format (optional) - Set to "text" for plain text output</li>
|
|
</ul>
|
|
<p><strong>Example:</strong> GET https://inou.com/api/dossiers?token=YOUR_TOKEN</p>
|
|
|
|
<h3>GET /api/studies</h3>
|
|
<p>List all imaging studies in a dossier.</p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<ul>
|
|
<li>token (required) - Your authentication token</li>
|
|
<li>dossier_guid (required) - The dossier GUID to query</li>
|
|
<li>format (optional) - Set to "text" for plain text output</li>
|
|
</ul>
|
|
<p><strong>Example:</strong> GET https://inou.com/api/studies?token=YOUR_TOKEN&dossier_guid=DOSSIER_ID</p>
|
|
|
|
<h3>GET /api/series</h3>
|
|
<p>List all series in a study.</p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<ul>
|
|
<li>token (required) - Your authentication token</li>
|
|
<li>dossier_guid (required) - The dossier GUID</li>
|
|
<li>study_guid (required) - The study GUID</li>
|
|
<li>filter (optional) - Filter by description (e.g., "T1", "FLAIR", "SAG")</li>
|
|
<li>format (optional) - Set to "text" for plain text output</li>
|
|
</ul>
|
|
<p><strong>Example:</strong> GET https://inou.com/api/series?token=YOUR_TOKEN&dossier_guid=DOSSIER_ID&study_guid=STUDY_ID</p>
|
|
|
|
<h3>GET /api/slices</h3>
|
|
<p>List all slices in a series with position data.</p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<ul>
|
|
<li>token (required) - Your authentication token</li>
|
|
<li>dossier_guid (required) - The dossier GUID</li>
|
|
<li>series_guid (required) - The series GUID</li>
|
|
<li>format (optional) - Set to "text" for plain text output</li>
|
|
</ul>
|
|
<p><strong>Example:</strong> GET https://inou.com/api/slices?token=YOUR_TOKEN&dossier_guid=DOSSIER_ID&series_guid=SERIES_ID</p>
|
|
|
|
<h3>GET /image/{slice_guid}</h3>
|
|
<p>Fetch a slice as PNG image.</p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<ul>
|
|
<li>slice_guid (in path, required) - The slice GUID</li>
|
|
<li>token (required) - Your authentication token</li>
|
|
<li>ww (optional) - Window width for contrast (Brain=80, Bone=2000)</li>
|
|
<li>wc (optional) - Window center for brightness (Brain=40, Bone=500)</li>
|
|
</ul>
|
|
<p><strong>Example:</strong> GET https://inou.com/image/SLICE_GUID?token=YOUR_TOKEN</p>
|
|
|
|
<p>Default response is JSON. Add <code>&format=text</code> for plain text output.</p>
|
|
|
|
</body>
|
|
</html>
|