De koppeling kan gestart worden via de API. Doe dit door het volgende aan te roepen.
Endpoint
/api/execute/mapping
Body
In de body moeten het nummer van de koppeling zitten en eventueel de parameter waarden. Deze parameter waarden overschrijven de waarden in de koppeling en de koppeling zal met deze waarden worden uitgevoerd.
In de body worden een aantal waarden gebruikt:
[KOPPELING ID]
Dit is het nummer van de koppeling. Deze is te vinden in het koppelingenoverzicht in de kolom ID.
[NAAM PARAMETER]
Dit is de naam van de parameter (indien aanwezig) zoals in de koppeling gedefinieerd.
[WAARDE PARAMETER ALS BASE64]
Dit is de waarde van het script voor deze parameter. Let dus op dat dit een script betreft. Deze waarde moet omgezet worden naar een base64 string. Dit kan je doen door bijvoorbeeld gebruik te maken een website als https://www.base64encode.org/
Zie hieronder enkele voorbeelden:
Tekst waarde insturen naar parameter
Code Block | ||
---|---|---|
| ||
'Mooqe U-turn' |
Hiervoor moet je de waarde
J01vb3FlIFUtdHVybic=
insturen
Nummer insturen als parameter
Code Block | ||
---|---|---|
| ||
123 |
Hiervoor moet je de waarde
MTIz
insturen
Voorbeeld aanroepen koppeling zonder parameter
Code Block | ||
---|---|---|
| ||
{
"MappingID": [KOPPELING ID],
"Mapping_Parameters": []
} |
Voorbeeld aanroepen koppeling met 1 parameter
Code Block | ||
---|---|---|
| ||
{
"MappingID": [KOPPELING ID],
"Mapping_Parameters": [
{
"Parameter": {
"Name":"[NAAM PARAMETER]",
"Value":"[WAARDE PARAMETER ALS BASE64]"
}
}
]
} |
Voorbeeld aanroepen koppeling met meerdere parameters
Code Block | ||
---|---|---|
| ||
{
"MappingID": [KOPPELING ID],
"Mapping_Parameters": [
{
"Parameter": {
"Name":"[NAAM PARAMETER 1]",
"Value":"[WAARDE PARAMETER 1 ALS BASE64]"
}
},
{
"Parameter": {
"Name":"[NAAM PARAMETER 2]",
"Value":"[WAARDE PARAMETER 2 ALS BASE64]"
}
}
]
} |
Voorbeeld aanroep
...