ONTIME API Documentatie

CALL

Deze API biedt de mogelijkheid om steeds de actieve, mogelijke producten op te halen voor uw bedrijf/klantennummer.

URL	https://api.asx.be/DISTRI/
METHOD	POST

REQUEST / INPUT

Hieronder krijgt u de structuur die gehanteerd wordt als input, inclusief een illustrerend voorbeeld en meer informatie per veld.
U mag zelf de keuze maken of u de gegevens naar ons toestuurt via JSON of XML

Niveau / Veld		Verplicht	Voorbeeld	Omschrijving
1	verwerking	*	PRODUCT	een overzicht van alle mogelijke producten voor uw klantnummer wordt opgehaald.
1	gebruiker	*	info@ontime.be	Emailadres waarop de API-account werd gedefinieerd. Max 250 karakters
1	klantnr	*	K01234	Dit is het DISTRI klantennummer bij ON TIME Logistics. Numeriek, voorafgaand met een 'K'
1	apipswd	*	c40b0c360f3d4959b53b103b25759542	Paswoord van de API-account
1	omgeving	*	TEST	TEST = TEST omgeving LIVE = LIVE omgeving

JSON voorbeeld

XML voorbeeld

<?xml version="1.0" encoding="utf-8"?>
<WebOrder> 
    <verwerking>PRODUCT</verwerking>
    <gebruiker>info@ontime.be</gebruiker>
    <klantnr>K01234</klantnr>
    <apipswd>c40b0c360f3d4959b53b103b25759542</apipswd>
    <omgeving>TEST</omgeving>
</WebOrder>

RESPONSE / OUTPUT

Hieronder krijgt u de structuur die gehanteerd wordt als output, inclusief een illustrerend voorbeeld en meer informatie per veld.
Indien u heeft gestuurd met JSON, zal u JSON ontvangen, idem met XML

Niveau / Veld				Voorbeeld	Omschrijving
1	status			SUCCESS
1	remarks
	2	remark		Er werd 1 productn gevonden	Informatieve opmerkingen
1	producten
	2	product
		3	verpakking	BLOKPAL
		3	Omschrijving	BLOKPALLET max 300kg - 1.2 - 0 - 300	Deze omschrijving gebruik je bij het aanmaken van een distributie opdrachten onder 'goederen'
		3	volume	1.2	default = volume
		3	volume_aanpassen	1	Indien 1 : dan mag u zelf het volume wijzigen in de opdracht Indien 0 : dan wordt steeds de waarde van 'volume' gebruikt
		3	gewicht	300	default = gewicht
		3	gewicht_aanpassen	1	Indien 1 : dan mag u zelf het gewicht wijzigen in de opdracht Indien 0 : dan wordt steeds de waarde van 'gewicht' gebruikt
		3	lengte	0	default = lengte
		3	lengte_aanpassen	1	Indien 1 : dan mag u zelf de lengte wijzigen in de opdracht Indien 0 : dan wordt steeds de waarde van 'gewicht' gebruikt

Niveau / Veld			Voorbeeld	Omschrijving
1	status		ERROR
1	remarks
	2	remark	foutieve credentials	Oplijsting van de gevonden fouten

JSON antwoord bij SUCCES

JSON antwoord bij ERROR

XML antwoord bij SUCCES

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>SUCCESS</status>
    <remarks>
        <remark>er werden 3 producten gevonden</remark>
    </remarks>
    <producten>
        <product>
            <verpakking>BLOKPAL</verpakking>
            <omschrijving>BLOKPALLET max 300kg - 1.2 - 0 - 300</omschrijving>
            <volume>1.2</volume>
            <volume_aanpassen>1</volume_aanpassen>
            <gewicht>300</gewicht>
            <gewicht_aanpassen>1</gewicht_aanpassen>
            <lengte>0</lengte>
            <lengte_aanpassen>1</lengte_aanpassen>
        </product>
        <product>
            <verpakking>COLLI</verpakking>
            <omschrijving>COLLI 30-60kg - 0.4 - 0 - 60</omschrijving>
            <volume>0.4</volume>
            <volume_aanpassen>1</volume_aanpassen>
            <gewicht>60</gewicht>
            <gewicht_aanpassen>1</gewicht_aanpassen>
            <lengte>0</lengte>
            <lengte_aanpassen>1</lengte_aanpassen>
        </product>
        <product>
            <verpakking>COLLI</verpakking>
            <omschrijving>colli (50-60kg) - 0.4 - 0 - 60</omschrijving>
            <volume>0.4</volume>
            <volume_aanpassen>1</volume_aanpassen>
            <gewicht>60</gewicht>
            <gewicht_aanpassen>1</gewicht_aanpassen>
            <lengte>0</lengte>
            <lengte_aanpassen>1</lengte_aanpassen>
        </product>
    </producten>
</WebAnswer>

XML antwoord bij ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>foutieve credentials</remark>
    </remarks>
</WebAnswer>

CONTROLE/TEST

Via deze functie kan u elke JSON of XML input uitproberen.
OPGELET : Deze functie wordt STEEDS in de TEST omgeving uitgevoerd

Uw INPUT string

Het resultaat/antwoord:

Ophalen DISTRI producten