Documentatie voor developers
Integreren en koppelen met Odigos
Odigos biedt API’s en integratie-mogelijkheden om externe systemen te koppelen aan bedrijfsprocessen. Deze pagina helpt je snel bepalen waar je moet zijn om een koppeling te bouwen of technische vragen te beantwoorden.
De documentatie is bedoeld voor externe integratiepartners en IT-afdelingen via API’s met Odigos werken.
Wat wil je bouwen of koppelen?
Een externe applicatie koppelen aan Odigos
Je wilt data uitwisselen tussen Odigos en een ander systeem.
Je gaat hierheen als je:
- API-calls wilt doen naar Odigos
- data wilt lezen of muteren
- een externe actie wilt starten vanuit een proces
Authenticatie en toegang regelen
Je wilt veilig toegang krijgen tot de API’s.
Je gaat hierheen als je:
- API-sleutels nodig hebt
- Rechten in wil stellen
Reageren op gebeurtenissen
Je wilt dat jouw systeem reageert op wat er in Odigos gebeurt.
Je gaat hierheen als je:
- webhooks wilt ontvangen
- wilt reageren op processtappen of gebeurtenissen
Werken met data en dossiers via de API
Je wilt begrijpen hoe data in Odigos is opgebouwd en beschikbaar is.
Je gaat hierheen als je:
- dataobjecten wilt ophalen of aanpassen
- wilt weten waar procesdata wordt opgeslagen
- wilt begrijpen hoe Dossier en API samenhangen
Integreren met processen
Je wilt een koppeling gebruiken binnen een bedrijfsproces.
Je gaat hierheen als je:
- API-calls wilt configureren als processtap
- wilt begrijpen wanneer een call wordt uitgevoerd
- wilt zien hoe procesvoortgang en integraties samenhangen
Hoe Odigos omgaat met integraties
Integraties in Odigos zijn bedoeld ter ondersteuning van bedrijfsprocessen die gedurende de dag plaatsvinden.
Belangrijk om te weten:
- API-gebruik wordt afgerekend naar gebruik
- API’s zijn niet bedoeld voor hoogfrequente, continu draaiende automatisering
- Integraties worden vaak aangeroepen vanuit processen, maar data kan ook los benaderd worden
- Er worden geen garanties gegeven over beschikbaarheid, timing of doorlooptijden.
Fouten en inzicht
Als er iets misgaat bij een koppeling, kun je op meerdere plekken inzicht krijgen.
Je gebruikt:
- Murphy voor foutmeldingen en technische details
- StatusQuo om te zien of een proces verder is gekomen
- Dossier om te controleren of data is aangepast
- Sentinel voor API-sleutels en toegang
Hoe deze documentatie is opgebouwd
- Deze pagina helpt je snel de juiste technische route te kiezen
- Subpagina’s gaan dieper in op één onderwerp
- Architectuur en procescontext worden op hoofdlijnen uitgelegd, met verwijzingen naar beheer-documentatie
Begin hier als je nog niet weet waar je moet zoeken.