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	*	TYRE	een overzicht van alle mogelijke adressen voor de 'TYRE-EXCHANGE' worden 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
1	RSnr		123456	Indien u het adres van 1 specifieke onderneming wenst op te halen, gebruik deze RS-nummer. Indien dit niet is ingevuld, zullen 'alle' adressen worden aangeboden.

JSON voorbeeld

XML voorbeeld

<?xml version="1.0" encoding="utf-8"?>
<WebOrder> 
    <verwerking>TYRE</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 werden 2 adressen gevonden	Informatieve opmerkingen
1	adressen
	2	adres
		3	bedrijf		Firma X	Naam van het bedrijf
		3	groep		TSE	Groepering
		3	contact		Jan Janssens	Contactpersoon binnen het bedrijf
		3	adres		Statiestraat	Straat (huisnummer mogelijk)
		3	huisnr		20	Huisnummer + busnummer
		3	adres2			Eventueel tweede adresregel
		3	postcode		2000	postcode
		3	gemeente		Antwerpen	gemeente
		3	email		info@test.be	emailadres (indien meerdere, gescheiden door ; )
		3	RSnr		123456	RS nummer
		3	tel		3212345678	Telefoonnummer ZONDER tekens
		3	uren
			4	maandag	09:00-12:00-13:00-17:00	Openingsuren van dit adres op MAANDAG: Vanaf voormiddag - tot voormiddag - vanaf namiddag - tot namiddag Formaat : hh:mm-hh:mm-hh:mm-hh:mm
			4	dinsdag	09:00-12:00-13:00-17:00	DINSDAG
			4	woensdag	09:00-12:00-13:00-17:00	WOENSDAG
			4	donderdag	09:00-12:00-13:00-17:00	DONDERDAG
			4	vrijdag	09:00-12:00-13:00-17:00	VRIJDAG
			4	zaterdag	09:00-12:00-13:00-17:00	ZATERDAG
		3	uniekNr		123456	uniek adresnummer

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 2 adressen gevonden</remark>
    </remarks>
    <adressen>
        <adres>
            <bedrijf>Firma X</bedrijf>
            <groep>TSE</groep>
            <contact>Jan Janssens</contact>
            <adres>Statiestraat</adres>
            <huisnr>20</huisnr>
            <adres2></adres2>
            <postcode>2000</postcode>
            <gemeente>Antwerpen</gemeente>
            <email>info@test.be</email>
            <RSnr>123456</RSnr>
            <tel>123456</tel>
            <uren>
                <maandag>09:00-12:00-13:00-17:00</maandag>
                <dinsdag>09:00-12:00-13:00-17:00</dinsdag>
                <woensdag>09:00-12:00-00:00-00:00</woensdag>
                <donderdag>09:00-12:00-13:00-17:00</donderdag>
                <vrijdag>09:00-12:00-13:00-17:00</vrijdag>
                <zaterdag>00:00-00:00-00:00-00:00</zaterdag>
            </uren>
        </adres>
        <adres>
            <bedrijf>Firma X</bedrijf>
            <groep></groep>
            <contact>Jan Janssens</contact>
            <adres>Statiestraat</adres>
            <huisnr>20</huisnr>
            <adres2></adres2>
            <postcode>2000</postcode>
            <gemeente>Antwerpen</gemeente>
            <email>info@test.be</email>
            <RSnr>123456</RSnr>
            <tel>123456</tel>
            <uren>
                <maandag>09:00-12:00-13:00-17:00</maandag>
                <dinsdag>09:00-12:00-13:00-17:00</dinsdag>
                <woensdag>09:00-12:00-00:00-00:00</woensdag>
                <donderdag>09:00-12:00-13:00-17:00</donderdag>
                <vrijdag>09:00-12:00-13:00-17:00</vrijdag>
                <zaterdag>00:00-00:00-00:00-00:00</zaterdag>
            </uren>
        </adres>
    </adressen>
</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 'Type Exchange' Adressen