Zoekresultaten
Connect Docsv4.2.0
Het hele contract binnen bereik.
Alle negentien publieke operaties, met per operatie een directe link naar de originele referentie.
Ruwe documentatie
Wil je het contract lezen zonder toelichting? Open dan de originele bronnen. Ze zijn leidend; deze gids ordent en legt uit.
| Bron | Testomgeving | Productie |
|---|---|---|
| API-referentie | Staging | Productie |
| OpenAPI-contract | Staging | Productie |
| Integratiegids | Staging | Productie |
| Koppelingsgids | Staging | Alleen via de Playground |
Gecontroleerd op 3 oktober 2026. Staging en productie publiceren hetzelfde contract, OpenAPI 3.1 versie 1.0.0. De integratiegids gebruikt in zijn voorbeelden productie-URL's; test altijd op staging.
Contractregels in het kort
| Onderwerp | Regel | Uitleg |
|---|---|---|
| Routes | Gehoste sessie (Route 2A) en directe tekstverwerking (/run) zijn live in API v1. Route 2B, met audio vanaf je server, is op aanvraag en staat niet in het contract | Kies je route |
| Toegang | Bearer API-key met workflows:read, sessions:create en sessions:read | Stap 01 |
| Bereik | Alleen werkstromen die voor de API zijn ingeschakeld; alleen sessies die via de API zijn gestart | Stap 01 |
| Gehoste link | Toegang tot één sessie, verloopt na 72 uur | Stap 03 |
| Herhalen | Idempotency-Key op de drie startroutes, maximaal 255 tekens, venster van 24 uur | Stap 06 |
| Limieten | Startroutes 10 per minuut, opnieuw bezorgen 6 per minuut | Stap 06 |
| Postback | HMAC-SHA256 over de onbewerkte body, header X-Hysio-Signature | Stap 05 |
| Statussen | Sessie: in_progress, completed, cancelled. Stap: pending, awaiting_input, processing, completed | Stap 04 |
| Export | GET /sessions/{session}/export?format=txt, pdf of docx, voor afgeronde sessies | Zie de operaties hieronder |
Alle publieke operaties
Het contract telt negentien operaties, hier in vier groepen. Per operatie zie je waar deze gids hem uitlegt en een directe link naar dezelfde operatie in de originele referentie op staging. Daarnaast beschrijft de referentie de webhook sessionCompleted: dat is de postback uit stap 05.
Werkstromen ontdekken
Lees welke werkstromen, vragen en layouts je account kan gebruiken. Vraagt het recht workflows:read.
| Methode | Pad | Wat je ermee doet | In deze gids | Origineel |
|---|---|---|---|---|
| GET | /workflows | Werkstromen ontdekken die voor je account beschikbaar zijn | Stap 02 | Referentie |
| GET | /workflows/categories | Categorieën van werkstromen ophalen | Alleen in de referentie | Referentie |
| GET | /workflows/{workflow} | Eén werkstroom lezen, met de stappen in vaste volgorde | Stap 02 | Referentie |
| GET | /workflows/{workflow}/questions | Werkstroomvragen lezen, met api_name, verplichting en invoertype | Stap 02 | Referentie |
| GET | /workflows/{workflow}/available-responses | Beschikbare JSON-layouts en hun structuur lezen | Stap 02 | Referentie |
Sessies starten
De drie startroutes. Ze accepteren een Idempotency-Key en zijn begrensd op 10 aanvragen per minuut. Vraagt het recht sessions:create.
| Methode | Pad | Wat je ermee doet | In deze gids | Origineel |
|---|---|---|---|---|
| POST | /workflows/{workflow}/run | Tekst voor alle stappen in één aanvraag verwerken | Stap 03 | Referentie |
| POST | /workflows/{workflow}/start | Een interactieve sessie starten die je per stap doorloopt | Toelichting | Referentie |
| POST | /workflows/{workflow}/hosted-session | Een gehoste sessie starten en de link voor de zorgprofessional ophalen | Stap 03 | Referentie |
Sessies volgen en bijsturen
Lijsten, status en de stappen van een interactieve sessie. Lezen vraagt sessions:read, wijzigen vraagt sessions:create.
| Methode | Pad | Wat je ermee doet | In deze gids | Origineel |
|---|---|---|---|---|
| GET | /sessions | Sessies van je account opvragen, te filteren op status | Alleen in de referentie | Referentie |
| GET | /sessions/counts | Aantallen sessies per status opvragen | Alleen in de referentie | Referentie |
| GET | /sessions/{session} | Status en details van één sessie lezen | Stap 04 | Referentie |
| POST | /sessions/{session}/answers | De werkstroomvragen van een gehoste sessie beantwoorden | Alleen in de referentie | Referentie |
| POST | /sessions/{session}/input | Invoer voor de huidige stap insturen | Toelichting | Referentie |
| POST | /sessions/{session}/draft | Een tussenversie van de huidige stap bewaren | Alleen in de referentie | Referentie |
| POST | /sessions/{session}/cancel | Een lopende sessie annuleren | Alleen in de referentie | Referentie |
Resultaat en herstel
Uitvoer lezen, exporteren en een postback opnieuw laten bezorgen. Lezen vraagt sessions:read, opnieuw bezorgen vraagt sessions:create.
| Methode | Pad | Wat je ermee doet | In deze gids | Origineel |
|---|---|---|---|---|
| GET | /sessions/{session}/output | Verslag en JSON van een afgeronde sessie lezen | Stap 04 | Referentie |
| GET | /sessions/{session}/export | Een afgeronde sessie exporteren als txt, pdf of docx | Alleen in de referentie | Referentie |
| POST | /sessions/{session}/postback/resend | De postback opnieuw laten bezorgen | Stap 06 | Referentie |
| GET | /sessions/{session}/documents/{document}/download | Een document van een sessie downloaden | Alleen in de referentie | Referentie |
Route 2B en geplande uitbreidingen
Deze onderdelen staan niet in het huidige contract en horen niet bij de negentien operaties hierboven. Er is geen datum. Bouw er niet op voordat ze in het contract en in deze gids staan.
- Route 2B, direct server-to-server met audio. Jouw EPD neemt zelf op en zet de audio vanaf je server door, zonder gehoste pagina.
- Praktijk- of cliëntkenmerk per API-key. Een eigen kenmerk en uitvoerprofiel per key.
- Veilig herhalen op losse stappen. Een
Idempotency-Keyook voor invoer op/input.
Wil je een van deze routes gebruiken? Bespreek het in de technische intake via Contact & Toegang.
Buiten deze API
Accountbeheer, het aanmaken van API-keys en het bewerken van een verslag lopen via de Hysio-app, niet via deze API. Een bewerking van de uitvoer met een API-key wordt geweigerd. Wat niet in het contract staat, hoort bij de app zelf: bouw daar niet op.
Versie en controle
Het contract is OpenAPI 3.1, versie 1.0.0. Staging en productie publiceren hetzelfde contract; alleen de server-URL verschilt. Hysio heeft deze gids op 3 oktober 2026 met dat contract vergeleken. Leg voor je eigen integratie de ophaaldatum en een hash van het contract vast.