Basisprincipes: parameters via headers of de URL

Alle parameters wordt via headers door gegeven of via url parameters. De keuze hiervoor wordt gemaakt door de developer die de implementatie verzorgd. Er is geen verschil in functionaliteit.

Ter voorbeeld het ophalen van alle lopende proces instanties:

Via headers

Header

Value

X-action

process-instances

X-apiKey

71C41004-6E3E-11E4-8C1A-F7BB2492C704

 

Via URL parameters

https://api.alley-oop.eu/api/?action=process-instances&apiKey=71C41004-6E3E-11E4-8C1A-F7BB2492C704

Verschillen

Het belangrijkste verschil zit hem in de naamgeving. Bij gebruik van headersstaat er altijd X- voor de parameternaam. Bij gebruik van URL parameters moet het X- voorvoegsel juist niet worden gebruikt. In deze documentatie worden voorbeelden enkel weergegeven in de vorm van headers.

Hebt u meer vragen? Een aanvraag indienen

0 Opmerkingen

U moet u aanmelden om een opmerking te plaatsen.
Mogelijk gemaakt door Zendesk