ONTIME API Documentatie

CALL

Deze API biedt de mogelijkheid aan om een nieuwe CITY, DISTRI of SPRINT naar ons toe te sturen.

URL	https://api.asx.be/COMBO/
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	service			*	CITY	CITY, DISTRI of SPRINT
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	webhook					Deze optie is enkel nodig indien u de tracking automatisch wenst te ontvangen zodra er een status-verandering is. Voor meer informatie hierover, ga naar de webhook-documentatie
	2	functie			URL	Mogelijke waarden: FTP of URL Indien u kiest voor FTP dient de FTP-connectie ingesteld te worden door onze beheerders
	2	url			https://www.urlnaaruwscript	enkel noodzakelijk indien FUNCTIE = URL
	2	methode			POST	indien FUNCTIE = URL => kies POST of GET indien FUNCTIE = XML => kies XML of JSON
	2	email			your@email.be	niet verplicht, maar indien er geen connectie kan gemaakt worden met uw webhookfunctie EN dit emailadres is ingesteld, sturen wij u een mail met de status-informatie
1	ophalen
	2	datum			2025-02-05	datum dat deze opdracht moet worden OPGEHAALD Formaat YYYY-MM-DD Indien u deze datum niet invult, zal deze opdracht zo snel mogelijk worden uitgevoerd
	2	uur			16:15	Uurformaat HH:MM Enkel in te vullen indien er een deadline is
	2	bedrijf		*	Ontime Logistics	Naam van het bedrijf Max 250 karakters
	2	contact		*	Jean-Claude Van Den Berghe	Naam van de contactpersoon binnen dit bedrijf Max 250 karakters
	2	adres1		*	Kattendijkdok 5A	Straatnaam + Huisnummer + busnummer Max 250 karakters
	2	adres2				Eventuele tweede adresregel Max 250 karakters
	2	postcode		*	2000	Max 4 karakters
	2	gemeente		*	Antwerpen	Max 250 karakters
	2	tel		*	0471334455	Telefoonnummer ZONDER tekens
	2	land			BE	Indien niet ingevuld = BE Enkel BE, NL, LU mogelijk! NL en LU enkel mogelijk voor de service DISTRI
1	leveren
	2	datum			2025-02-05	Datum dat deze opdracht moet worden GELEVERD Formaat YYYY-MM-DD Indien u deze datum niet invult, zal deze opdracht zo snel mogelijk worden uitgevoerd
	2	uur			16:15	Uurformaat HH:MM Enkel in te vullen indien er een deadline is
	2	bedrijf		*	Ontime Logistics	Naam van het bedrijf Max 250 karakters
	2	contact		*	Jean-Claude Van Den Berghe	Naam van de contactpersoon binnen dit bedrijf Max 250 karakters
	2	adres1		*	Kattendijkdok 5A	Straatnaam + Huisnummer + busnummer Max 250 karakters
	2	adres2				Eventuele tweede adresregel Max 250 karakters
	2	postcode		*	2000	Max 4 karakters
	2	gemeente		*	Antwerpen	Max 250 karakters
	2	tel		*	0471334455	Telefoonnummer ZONDER tekens
	2	land			BE	Indien niet ingevuld = BE Enkel BE, NL, LU mogelijk! NL en LU enkel mogelijk voor de service DISTRI
1	goederen
	2	goed
		3	aantal	*	7	aantal documenten/colli's die moeten verwerkt worden voor deze opdracht Numeriek veld
		3	type	*	PAKKET	PAKKET of BRIEF
		3	gewicht	*	1.25	Gewicht in KG Gebruik decimaal PUNT
		3	breedte	(*)	7	Breedte in CM (*) ENKEL indien type = PAKKET Gebruik decimaal PUNT
		3	hoogte	(*)	7	Hoogte in CM (*) ENKEL indien type = PAKKET Gebruik decimaal PUNT
		3	lengte	(*)	7	Lengte in CM (*) ENKEL indien type = PAKKET Gebruik decimaal PUNT
		3	oms		Omschrijving	Omschrijving van de goederen

JSON voorbeeld met 1 x goederen

JSON voorbeeld met 2 x goederen

XML voorbeeld met 1 x goederen

<?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>
    <service>CITY</service>
    <verzender>
        <contact>Ann Flecyn</contact>
        <email>info@ontime.be</email>
        <referentie>dit is een test</referentie>
        <tel>0123456789</tel>
    </verzender> 
    <ophalen>
        <datum>2020-01-27</datum>
        <uur>16:15</uur>
        <bedrijf>Ontime Logistics</bedrijf>
        <contact>Jean-Claude Van Den Berghe</contact>
        <adres1>Kattendijkdok 5A</adres1>
        <adres2></adres2>
        <postcode>2000</postcode>
        <gemeente>Antwerpen</gemeente>
        <tel>963214785</tel>
    </ophalen>  
    <leveren>
        <datum>2020-01-27</datum>
        <uur>16:15</uur>
        <bedrijf>Ontime Logistics</bedrijf>
        <contact>Jean-Claude Van Den Berghe</contact>
        <adres1>Kattendijkdok 5A</adres1>
        <adres2></adres2>
        <postcode>2000</postcode>
        <gemeente>Antwerpen</gemeente>
        <tel>963214785</tel>
    </leveren> 
    <goederen>
        <goed>
            <aantal>1</aantal>
            <type>PAKKET</type>
            <gewicht>1.25</gewicht>
            <lengte>0.5</lengte>
            <breedte>0.5</breedte>
            <hoogte>0.5</hoogte>
            <oms>omschrijving van de goederen</oms>
        </goed>
    </goederen>
</WebOrder>

XML voorbeeld met 2 x goederen

<?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>
    <service>CITY</service>
    <verzender>
        <contact>Ann Flecyn</contact>
        <email>info@ontime.be</email>
        <referentie>dit is een test</referentie>
        <tel>0123456789</tel>
    </verzender> 
    <ophalen>
        <datum>2020-01-27</datum>
        <uur>16:15</uur>
        <bedrijf>Ontime Logistics</bedrijf>
        <contact>Jean-Claude Van Den Berghe</contact>
        <adres1>Kattendijkdok 5A</adres1>
        <adres2></adres2>
        <postcode>2000</postcode>
        <gemeente>Antwerpen</gemeente>
        <tel>963214785</tel>
    </ophalen>  
    <leveren>
        <datum>2020-01-27</datum>
        <uur>16:15</uur>
        <bedrijf>Ontime Logistics</bedrijf>
        <contact>Jean-Claude Van Den Berghe</contact>
        <adres1>Kattendijkdok 5A</adres1>
        <adres2></adres2>
        <postcode>2000</postcode>
        <gemeente>Antwerpen</gemeente>
        <tel>963214785</tel>
    </leveren> 
    <goederen>
        <goed>
            <aantal>1</aantal>
            <type>PAKKET</type>
            <gewicht>1.25</gewicht>
            <lengte>0.5</lengte>
            <breedte>0.5</breedte>
            <hoogte>0.5</hoogte>
            <oms>omschrijving van de goederen</oms>
        </goed>
        <goed>
            <aantal>2</aantal>
            <type>BRIEF</type>
            <gewicht>1.25</gewicht>
            <lengte>0</lengte>
            <breedte>0</breedte>
            <hoogte>0</hoogte>
            <oms>omschrijving van de goederen</oms>
        </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	ASXxxxx	Het opdrachtnummer
		3	track	https://track.asx.be/xxxxx	Link naar de online trackingpagina
		3	pdf	https://portal.asx.be/pdf/bestelling/?bestelling=zzzzz	Link naar het bestelformulier

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 een stadsopdracht aangemaakt</remark>
    </remarks>
    <opdrachten>
        <opdracht>
            <nummer>ASDxxxxx</nummer>
            <track>https://track.asx.be/xxxxx</track>
            <pdf>https://portal.asx.be/pdf/bestelling/?bestelling=zzzzzzz</pdf>
        </instructie>
    </instructies>
</WebAnswer>

XML antwoord bij ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>opdracht - datum kan niet in het verleden liggen</remark>
        <remark>opdracht - bestemming-bedrijf 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 COMBO opdracht doorsturen