ONTIME API Documentatie

CALL

Deze API biedt de mogelijkheid aan om een nieuwe sprint opdracht naar ons toe te sturen.

URL	https://api.asx.be/SPRINT/
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			*	CREATE	Er zal een nieuwe opdracht worden aangemaakt zodra alle controles zijn gebeurd
1	gebruiker			*	info@ontime.be	Emailadres waarop de API-account werd gedefinieerd. Max 250 karakters
1	klantnr			*	1234	Dit is het klantennummer bij ON TIME Logistics. numeriek, zonder voorgaande zeroes
1	apipswd			*	c40b0c360f3d4959b53b103b25759542	Paswoord van de API-account
1	omgeving			*	TEST	TEST = TEST omgeving LIVE = LIVE omgeving
1	verzender
	2	contact		*	Ann Flecyn	Naam van de persoon die de opdracht aanmaakt Max 250 karakters
	2	email		*	info@ontime.be	Emailadres van de persoon die de opdracht aanmaakt Max 250 karakters
	2	referentie		*	dit is een test	Algemene referentie die zal vermeld worden op het factuur Max 30 karakters
	2	tel		*	0123546789	Telefoonnummer van de persoon die de opdracht aanmaakt ZONDER tekens
1	opdracht
	2	productnr		*	18	uniek nummer van het product numerieke waarde Indien u de producten specifiek voor uw klantnummer wenst op te halen: Klik hier.
	2	voertuignr		*	2	uniek nummer van het voertuig numerieke waarde Indien u de voertuigen specifiek voor uw productnummer wenst op te halen: Klik hier.
	2	ordermail		*	info@asx.be	emailadres waarnaar orderbevestiging wordt verstuurd
	2	vrachtbrief			Vrije opmerking	opmerking die wordt genoteerd op de vrachtbrief
1	bestemmingen
	2	bestemming
		3	num	*	1	opvolgnummer, startend vanaf 1 Minstens 2 bestemmingen in te geven
		3	taak	*	1	1 = OPHALEN 2 = LEVEREN 3 = OPHALEN + LEVEREN
		3	bedrijf	*	Ontime Logistics	Naam van het bedrijf
		3	adres1	*	Kattendijkdok 5	Adresregel 1
		3	adres2		Oostkaai	Adresregel 2
		3	land	*	BE	Dit is de landcode
		3	postcode	*	2000	postcode
		3	gemeente	*	Antwerpen	gemeente
		3	tel	*	0497123456	Telefoonnummer ZONDER tekens
		3	contact	*	Mevrouw Spitaels	Naam van de contactpersoon binnen dit bedrijf
		3	info		Vrije tekst	Bijkomende informatie over deze bestemming
		3	datum	(*)	2020-07-14	datum waarop de 'taak' dient uitgevoerd te worden Verplicht voor bestemming 1 De bestemmingen worden onmiddellijk en aansluitend uitgevoerd na elkaar. Enkel indien u een ander tijdstip wenst, vult u vanaf bestemming 2 een andere datum, van en tot in
		3	van	(*)	12:00	tijdstip vanaf Verplicht voor bestemming 1
		3	tot	(*)	16:00	tijdstip tot Verplicht voor bestemming 1
1	goederen
	2	goed
		3	aantal	*	1	aantal goederen
		3	type	*	pakket	Mogelijke waarden: pakket document pallet ander
		3	gewicht	*	25	Gewicht in KG
		3	lengte		100	Lengte in CM
		3	breedte		20	Breedte in CM
		3	hoogte		30	Hoogte in CM
		3	info		meubelen	Omschrijving van de goederen
		3	ophalen	*	1	NUM van de bestemming waar moet opgehaald worden
		3	leveren	*	2	NUM van de bestemming waar moet geleverd worden

JSON voorbeeld

XML voorbeeld

<?xml version="1.0" encoding="utf-8"?>
<WebOrder> 
    <verwerking>CREATE</verwerking>
    <gebruiker>info@ontime.be</gebruiker>
    <klantnr>1234</klantnr>
    <apipswd>c40b0c360f3d4959b53b103b25759542</apipswd>
    <omgeving>TEST</omgeving>
    <verzender>
        <contact>Ann Flecyn</contact>
        <email>info@ontime.be</email>
        <referentie>dit is een test</referentie>
        <tel>0123456789</tel>
    </verzender> 
        <opdracht>
            <productnr>18</productnr>
            <voertuignr>2</voertuignr>
            <ordermail>info@asx.be</ordermail>
            <vrachtbrief>deze vrije opmerking komt op de vrachtbrief</vrachtbrief>
        </opdracht>
        <bestemmingen>
            <bestemming>
                <num>1</num>
                <taak>1</taak>
                <bedrijf>Ontime Logistics</bedrijf>
                <adres1>Kattendijkdok 5</adres1>
                <adres2>Oostkaai</adres2>
                <land>BE</land>
                <postcode>2000</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>0497123456</tel>
                <contact>Mevrouw Spitaels</contact>
                <info>letop, de hond bijt</info>
                <datum>2020-07-14</datum>
                <van>12:00</van>
                <tot>16:00</tot>
            </bestemming>
            <bestemming>
                <num>2</num>
                <taak>2</taak>
                <bedrijf>ASX-Ibeco</bedrijf>
                <adres1>De Keizelei 239</adres1>
                <adres2></adres2>
                <land>BE</land>
                <postcode>2001</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>0497123456</tel>
                <contact>Jan Smits</contact>
                <info></info>
                <datum></datum>
                <van></van>
                <tot></tot>
            </bestemming>
        </bestemmingen>
        <goederen>
            <goed>
                <aantal>1</aantal>
                <type>pakket</type>
                <gewicht>25</gewicht>
                <lengte>100</lengte>
                <breedte>20</breedte>
                <hoogte>30</hoogte>
                <info>meubelen</info>
                <ophalen>1</ophalen>
                <leveren>2</leveren>
            </goed>
        </goederen>
</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 opdracht aangemaakt	Informatieve opmerkingen
1	opdrachten
	2	opdracht
		3	nummer				xxxx	Het opdrachtnummer
		3	tracknr				GI3TMNZZFUYTSNJABCD	uniek tracking nummer
		3	pdf				https://portal.asx.be/pdf/bestelling/?bestelling=zzzzz	Link naar het bestelformulier
		3	track_url				https://et.asx-ibeco.be/planning/tracktrace.php?trackingnr=GI3TMNZZFUYTSNJABCD	link naar de tracking
		3	order_rates
			4	order_total_excluding_vat			29.99	totaal bedrag excl. BTW
			4	order_total_including_vat			29.99	totaal bedrag incl. BTW
			4	rates
				5	rate
					6	description	KILOMETERS	beschrijving van de kost
					6	price	28	bedrag van de kost
		3	haltes
			4	halte
				5	nr		SPR123452020093000197_1	uniek nummer v/d halte
				5	bedrijf		Ontime Logistics	Naam van het bedrijf
				5	adres		Kattendijkdok 4 Oostkaai	volledig adres
				5	postcode		2020	postcode
				5	gemeente		Antwerpen	gemeente

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 werd 1 opdracht aangemaakt</remark>
    </remarks>
    <opdrachten>
        <opdracht>
            <nummer>195182</nummer>
            <bestelling>SPR123452020093000189</bestelling>
            <tracknr>GI3TMNZZFUYTSNJABCD</tracknr>
            <pdf>https://portal.asx.be/pdf/opdracht/?opdracht=e3173ed8a7123456789</pdf>
            <track_url>https://et.asx-ibeco.be/planning/tracktrace.php?trackingnr=GI3TMNZZFUYTSNJABCD</track_url>
            <order_rates>
                <order_total_excluding_vat>29.99</order_total_excluding_vat>
                <order_total_including_vat>29.99</order_total_including_vat>
                <rates>
                    <rate>
                        <description>KILOMETERS</description>
                        <price>28</price>
                    </rate>
                    <rate>
                        <description>BRANDSTOFTOESLAG</description>
                        <price>0.56</price>
                    </rate>
                    <rate>
                        <description>InterCompany 5%</description>
                        <price>1.43</price>
                    </rate>
                </rates>
            </order_rates>
            <haltes>
                <halte>
                        <nr>SPR123452020093000197_1</nr>
                        <bedrijf>Ontime Logistics</bedrijf>
                        <adres>Kattendijkdok 4 Oostkaai</adres>
                        <postcode>2000</postcode>
                        <gemeente>Antwerpen</gemeente>
                </halte>
                <halte>
                        <nr>SPR123452020093000197_2</nr>
                        <bedrijf>ASX-Ibeco</bedrijf>
                        <adres>straat nr</adres>
                        <postcode>1234</postcode>
                        <gemeente>Roeselare</gemeente>
                </halte>
            </haltes>
        </opdracht>
    </opdrachten>
</WebAnswer>

XML antwoord bij ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>datum kan niet in het verleden liggen</remark>
        <remark>bestemming verplicht in te vullen</remark>
        <remark>detail-aantal verplicht in te vullen</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:

Nieuwe SPRINT opdracht doorsturen