Terug naar website
Je bevindt je momenteel in de helpsectie van onze software, met antwoorden op veelgestelde vragen, handleidingen en hulp bij problemen. Voor volledige toegang tot onze nieuwe website, inclusief al onze producten en diensten, kun je hier klikken om naar de hoofdpagina te gaan.

API-functies

Dit onderdeel toont een overzicht van alle functies die beschikbaar worden gesteld door de API.

De functies kunnen worden aangeroepen wanneer de API actief is; in programma-instellingen legt u de hostnaam, poortnummer en root van de API vast.

Een functie selecteren

Aan de linkerzijde van het onderdeelvenster vindt u een lijst van alle mogelijke functies, gegroepeerd in categorieën. Klik op de pijlknop om een categorie te openen en selecteer vervolgens de gewenste functie.

U kunt ook zoeken op de naam van de functie in het zoekveld bovenaan de lijst.

Afhankelijk van de geselecteerde functie verschijnen bovenin het venster één of meer invoervelden waarin de parameters van de functie kunnen worden ingevuld.

Sommige functies vereisen invoergegevens in de vorm van een JSON-message. Deze JSON-message wordt automatisch gegenereerd aan de hand van de ingevoerde parameters en getoond in het linker tekstvenster onderin het onderdeelvenster. Klik op de tab 'Tokens' om deze invoer te zien als een lijst van JSON-tokens.

Een functie aanroepen

Halverwege het venster wordt de URL getoond die wordt gebruikt bij het aanroepen van de functie bij de API. 

De URL wordt opgebouwd uit de instellingen die zijn vastgelegd in programmainstellingen. Selecteer de bijbehorende pagina met de knop API-aanroepinstellingen .

De voorzijde van de URL toont de te gebruiken http-methode: GET, POST, PUT of DELETE.

Een aantal functies ondersteunt het gebruik van 'query parameters' waarmee het resultaat kan worden beperkt tot één of meer specifieke waarden, zoals artikelen van één bepaald artikelmerk. Selecteer eventueel een parameternaam en type achter de parameternaam = gevolgd door de gewenste parameterwaarde. De query parameterwaarden bij iedere functie worden bewaard per gebruiker.

Met de knop Helpinformatie opent u de pagina over de geselecteerde API-functie in de help van Order-Direct.

Klik op de knop 'Uitvoeren' om de geselecteerde functie aan te roepen met de ingevoerde parameters en eventuele query parameters.

Het resultaat van een functie bekijken

Het resultaat van iedere functie-aanroep wordt getoond in het tekstvenster rechtsonder in het onderdeelvenster.

Standaard wordt een functie-resultaat getoond in het JSON-formaat zoals dat wordt teruggegeven door de API.

Het tweede tabblad 'Geformatteerd' toont het resultaat in een leesbaar formaat.

Het derde tabblad 'Tokens' toont het functie-resultaat als een lijst van JSON-tokens met, mits van toepassing, de bijbehorende waarden.

Het onderdeel afsluiten

Verlaat het onderdeel met Esc of Afsluiten .