ONTIME API Documentatie

CALL

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

URL	https://api.asx.be/KAAI/
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
	2	prnt			*	CMP	CMP = De documenten zullen door onze koeriers bij u worden opgehaald ASX = De bijlagen zullen onmiddellijk bij ons worden afgeprint
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-01-14	Datum dat deze opdracht moet worden uitgevoerd Formaat YYYY-MM-DD
	2	middag			*	AM	AM = Voormiddag (tot 12:00) PM = Namiddag (vanaf 12:00)
	2	expres				1	1 = Express-behandeling en -facturering 0= GEEN express-behandeling
	2	deadline				16:15	Uurformaat HH:MM VERPLICHT indien express = 1
	2	bestemming				GIP LO	bestemming voor deze opdracht Mogelijke waarden : ANDERE DOUANE BACKOFFICE LO DOUANE BACKOFFICE RO DOUANE EERSTE KANTOOR DOUANE IVK DOUANE K363 MOTO1 DOUANE LILLO MOTO3 DOUANE SPITSENSTRAAT MOTO2 DOUANE TRIWAYS GIP (ZEEBRUGGE) GIP LO GIP LO FAVV DIENST PLANTEN GIP LO FAVV DIENST VET GIP RO KAAI 468 KAAI 118 KAAI 120 APM/CSP (ZEEBRUGGE) KAAI 1213 KAAI 1227 KAAI 1241 (HAVEN ANTWERPEN) KAAI 1333 KAAI 143 WIELINGDOK (ZEEBRUGGE) KAAI 1700 KAAI 1742 KAAI 1795 FAVV PLANTENDIENST KAAI 1795 FAVV VETERINAIRE DIENST KAAI 198 FAVV KAAI 242 KAAI 311 KAAI 338 KAAI 359 ABES KAAI 364 ATO KAAI 420 KAAI 496 KAAI 502 ICO (HAVEN ZEEBRUGGE) KAAI 519 ICO (HAVEN ZEEBRUGGE) KAAI 520 - 525 (HAVEN ZEEBRUGGE) KAAI 530 WALLENIUS (HAVEN ZEEBRUGGE) KAAI 730 KAAI 740 - MEXICONATIE KAAI 869 KAAI 913 MAGAZIJN ADM MAGAZIJN AFRULOG MAGAZIJN ALPHANATIE MAGAZIJN ALTAMIRA MAGAZIJN ANTVERPIA MAGAZIJN BEVERLAND MAGAZIJN BLOKVELDEN 1548 MAGAZIJN BVC MAGAZIJN CORRAL MAGAZIJN DOCKX LOGISTICS MAGAZIJN ESA LO MAGAZIJN ESA RO MAGAZIJN EUROCENTER MAGAZIJN GCT MAGAZIJN HANDICO MAGAZIJN IDP MAGAZIJN LEXUS MAGAZIJN LOGHIDDEN CITY MAGAZIJN LOTUS MAGAZIJN LUIKNATIE MAGAZIJN ON TIME K1616 MAGAZIJN POLAND MAGAZIJN POSEIDON MAGAZIJN SEA-INVEST MAGAZIJN SSC MAGAZIJN VALKENIERSNATIE MAGAZIJN VAN MOER MAGAZIJN VAN MOER RAIL MAGAZIJN VANGUARD MAGAZIJN WAAGNATIE MAGZIJN ECOCENTER - WIJNGAARDNATIE NOVA NATIE K420 ON TIME VERLUCHTINGZONE K1616 WIJNGAARDNATIE 109 Indien u de bestemmingen specifiek voor uw klantnummer wenst op te halen, gebruik de bestemming-API : Klik hier.
	2	bestemming_ander				ANDERE BESTEMMING	Indien u als bestemming 'ANDERE' heeft geselecteerd, is dit veld verplicht om de andere bestemming te noteren.
	2	bestemming_adres				SINT ANTONIUSWEG 9	Straat + nr van de bestemming
	2	bestemming_postcode				9130	Postcode van de bestemming
	2	bestemming_gemeente				Beveren	Gemeente van de bestemming
	2	bestemming_contact				naam van de persoon	Contactpersoon van de bestemming
	2	bestemming_tel				0478325678	Telefoonnummer van de bestemming (numeriek)
	2	instructie			*	AFGEVEN L/V	instructie die moet worden uitgevoerd voor deze opdracht Mogelijke waarden : AFGEVEN L/V AFSCHRIJVEN ANDERE CONTAINER STOCKEREN DOCUMENT(EN) LINKEN IN TUL SYSTEEM DOCUMENTCONTROLE DOCUMENTEN AFGEVEN DOUANESTOP LADEN LOSSEN MONDELINGE VRIJGAVE NAZICHT VALIDEREN ATR VALIDEREN EUR 1 VERLUCHTEN BIJ ON TIME VERLUCHTINGSZONE K1616 VRACHTLIJST AANZUIVEREN Indien u de instructies specifiek voor uw klantnummer wenst op te halen, gebruik de instructie-API : Klik hier.
	2	instructie_ander				ANDERE INSTRUCTIE	Indien u als instructie 'ANDERE' heeft geselecteerd, is dit veld verplicht om de andere instructie te noteren.
	2	eerstewerk				1	1 = JA, uw opdracht zal binnen de 2 uur worden uitgevoerd 0= Neen
	2	army				0	Enkel aan te duiden indien het gaat over documenten voor behandeling van legermateriaal van US of Canada 1 = Ja 0= Neen
	2	extra			*	3	0 = geen extra taak 1 = gasmeting uitvoeren 2 = fysieke verificatie uitvoeren 3 = fysieke verificatie + gasmeting
	2	extrainfo					Indien u gasmeting en/of fysieke verificatie heeft ingevuld, dienen één of meerdere velden van onderstaande blok te worden ingevuld.
		3	tijdstip		*	12:00	verplicht bij gasmeting EN fysieke verificatie
		3	verificateur		*	verificateur + ref. magazijn	Informatie over de transporteur, verificateur + ref. magazijn verplicht bij gasmeting EN fysieke verificatie
		3	gsm		(*)	0478325678	gsm na kantooruren (numeriek) ENKEL verplicht bij fysieke verificatie
		3	goederen		(*)	Omschrijving van de goederen	ENKEL verplicht bij gasmeting
		3	inhoud		*	CONTAINER	Indien gasmeting is geselecteerd, enige mogelijke waarde = CONTAINER Indien enkel fysieke verificatie, Mogelijke waarden : CONTAINER of STUKGOED
	2	containers
		3	container				Indien 'inhoud = CONTAINER', dient u hier alle containernummers op te sommen
			4	containernr		MSKU1234565
	2	documenten
		3	document				per document dat moet behandeld worden, kan u een document-tag toevoegen. Minstens 1 document verplicht
			4	type	*	IMA	Mogelijke waarden : IMA EXA T2L TRANSIT ANDER
			4	nummer	*	ABCD1234	documentnummer
	2	opmerking				Vrije opmerking
1	bijlagen
	2	bijlage
		3	naam			bijlage.pdf	Naam van uw bijlage
		3	bestand			JVBERi0xLjQKJeLjz9MNCjcgMCBvYmo KPDwKL1R5cGUvWE9iamVjdAovU...	BASE64_encoded

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>
        <prnt>CMP</prnt>
    </verzender> 
        <opdracht>
            <datum>2020-01-27</datum>
            <middag>AM</middag>
            <expres>1</expres>
            <deadline>16:15</deadline>
            <bestemming>GIP LO</bestemming>
            <bestemming_ander></bestemming_ander>
            <bestemming_adres>SINT ANTONIUSWEG 9</bestemming_adres>
            <bestemming_postcode>9130</bestemming_postcode>
            <bestemming_gemeente>Beveren</bestemming_gemeente>
            <bestemming_contact>Naam van de persoon</bestemming_contact>
            <bestemming_tel>0123456789</bestemming_tel>
            <instructie>NAZICHT</instructie>
            <instructie_ander></instructie_ander>
            <eerstewerk>0</eerstewerk>
            <army>0</army>
            <extra>3</extra>
            <extrainfo>
                <tijdstip>12:00</tijdstip>
                <verificateur>info betreffende deze tag</verificateur>
                <gsm>0498124578</gsm>
                <goederen>omschrijving van de goederen</goederen>
                <inhoud>CONTAINER</inhoud>
            </extrainfo>
                <containers>
                    <container>
                        <containernr>MSKU1234565</containernr>
                    </container>
                    <container>
                        <containernr>MSKU1296565</containernr>
                    </container> 
                </containers>
            <documenten>
                <document>
                    <type>IMA</type>
                    <nummer>IMA123456</nummer>
                </document>
                <document>
                    <type>T2L</type>
                    <nummer>T2L123456</nummer>
                </document>
                <document>
                    <type>TRANSIT</type>
                    <nummer>TRANS123456</nummer>
                </document>
            </documenten>
            <opmerking>hier mag je schrijven wat je wenst</opmerking>
        </opdracht>
    <bijlagen>
        <bijlage>
            <naam>Bijlage.pdf</naam>
            <bestand>JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU...</bestand>
        </bijlage>
    </bijlagen>
</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	ASKxxxx	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>KAAI opdracht succesvol aangemaakt</remark>
    </remarks>
    <opdrachten>
        <opdracht>
            <nummer>ASKxxxxx</nummer>
            <track>https://track.asx.be/xxxxx</track>
            <pdf>https://portal.asx.be/pdf/bestelling/?bestelling=zzzzzzz</pdf>
        </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 KAAI opdracht doorsturen