ONTIME API Documentatie

CALL

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

URL	https://api.asx.be/INTNAT/
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	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	opdracht
	2	datum			*	2025-02-05	datum dat deze opdracht moet worden uitgevoerd Formaat YYYY-MM-DD
	2	inhoud			*	BRIEF	Mogelijke waarden: BRIEF of PAKKET
	2	oms			*	verschillende brieven	omschrijving van de op te halen goederen
	2	tijdstip					Vul het uur in wanneer de zending klaar ligt voor ophaling
		3	van			10:00	uur vanaf
		3	tot			17:00	uur tem
	2	brief					enkel in te vullen indien inhoud = BRIEF
		3	aantal		*	7	aantal brieven
		3	gewicht		*	3.0	Het gewicht in KG van de totale zending
	2	pakketten					enkel in te vullen indien inhoud = PAKKET
		3	pakket
			4	aantal	*	1	aantal pakketten met deze afmetingen
			4	gewicht	*	0.5	Gewicht in KG
			4	lengte	*	29	Lengte in CM
			4	breedte	*	29	Breedte in CM
			4	hoogte	*	3	Hoogte in CM
	2	ophaling
		3	bedrijf		*	Ontime Logistics	Naam van het bedrijf Max 250 karakters
		3	adres1		*	Kattendijkdok 5A	Straatnaam + Huisnummer + busnummer Max 250 karakters
		3	adres2				Eventuele tweede adresregel Max 250 karakters
		3	postcode		*	2000	Max 4 karakters
		3	gemeente		*	Antwerpen	Max 250 karakters
		3	tel		*	0471334455	Telefoonnummer ZONDER tekens
		3	contact		*	Mevr. Spitaels	Naam van de contactpersoon binnen dit bedrijf
	2	bestemming
		3	bedrijf		*	Ontime Logistics	Naam van het bedrijf Max 250 karakters
		3	adres1		*	Kattendijkdok 5A	Straatnaam + Huisnummer + busnummer Max 250 karakters
		3	adres2				Eventuele tweede adresregel Max 250 karakters
		3	postcode		*	2000	Max 4 karakters
		3	gemeente		*	Antwerpen	Max 250 karakters
		3	land			BE	Dit is de landcode BE = Belgie, NL = Nederland, FR = Frankrijk, ... Indien leeg wordt de 'default' genomen = BE (Belgie)
		3	tel		*	0471334455	Telefoonnummer ZONDER tekens
		3	contact		*	Mevr. Spitaels	Naam van de contactpersoon binnen dit bedrijf

JSON voorbeeld met PAKKETTEN

JSON voorbeeld met BRIEVEN

XML voorbeeld met PAKKETTEN

<?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>
        <datum>2020-01-27</datum>
        <inhoud>PAKKET</inhoud>
        <oms>verschillende pakketten</oms>
        <tijdstip>
            <van>10:00</van>
            <tot>17:00</tot>
        </tijdstip>
        <pakketten>
            <pakket>
                <aantal>1</aantal>
                <gewicht>35</gewicht>
                <lengte>29</lengte>
                <breedte>29</breedte>
                <hoogte>3</hoogte>
            </pakket>
            <pakket>
                <aantal>5</aantal>
                <gewicht>25.66</gewicht>
                <lengte>10</lengte>
                <breedte>10</breedte>
                <hoogte>10</hoogte>
            </pakket>
        </pakketten>
        <ophaling>
            <contact>Mevr. Spitaels</contact>
            <adres1>Kattendijkdok 5A</adres1>
            <adres2></adres2>
            <postcode>2000</postcode>
            <gemeente>Antwerpen</gemeente>
            <tel>963214785</tel>
        </ophaling>
        <bestemming>
            <bedrijf>Ontime Logistics</bedrijf>
            <contact>Jean-Claude Van Den Berghe</contact>
            <adres1>Kattendijkdok 5A</adres1>
            <adres2></adres2>
            <postcode>2000</postcode>
            <gemeente>Antwerpen</gemeente>
            <land>BE</land>
            <tel>963214785</tel>
        </bestemming>
    </opdracht>
</WebOrder>

XML voorbeeld met BRIEVEN

<?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>
        <datum>2020-01-27</datum>
        <inhoud>BRIEF</inhoud>
        <oms>verschillende brieven</oms>
        <tijdstip>
            <van>10:00</van>
            <tot>17:00</tot>
        </tijdstip>
        <brief> 
            <aantal>3</aantal>
            <gewicht>0.5</gewicht>
        </brief>
        <ophaling>
            <contact>Mevr. Spitaels</contact>
            <adres1>Kattendijkdok 5A</adres1>
            <adres2></adres2>
            <postcode>2000</postcode>
            <gemeente>Antwerpen</gemeente>
            <tel>963214785</tel>
        </ophaling>
        <bestemming>
            <bedrijf>Ontime Logistics</bedrijf>
            <contact>Jean-Claude Van Den Berghe</contact>
            <adres1>Kattendijkdok 5A</adres1>
            <adres2></adres2>
            <postcode>2000</postcode>
            <gemeente>Antwerpen</gemeente>
            <land>BE</land>
            <tel>963214785</tel>
        </bestemming>
    </opdracht>
</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	ASSxxxx	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 1 nationale opdracht aangemaakt </remark>
    </remarks>
    <opdrachten>
        <opdracht>
            <nummer>ASXxxxxx</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>datum kan niet in het verleden liggen</remark>
        <remark>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 (INTER)NATIONALE opdracht doorsturen