ONTIME API Documentatie

CALL

Cette API permet de nous envoyer une nouvelle affectation de quai.

URL	https://api.asx.be/KAAI/
METHOD	POST

REQUEST / INPUT

Vous trouverez ci-dessous la structure utilisée comme entrée, ainsi qu'un exemple illustratif et des informations complémentaires pour chaque champ.
Vous pouvez choisir de nous envoyer les données via JSON ou XML.

Niveau/champ					Obligatoire	Exemple	Description
1	verwerking				*	CREATE	Une nouvelle commande sera créée une fois que toutes les vérifications auront été effectuées
1	gebruiker				*	info@ontime.be	Adresse électronique sur laquelle le compte API a été défini. 250 caractères maximum
1	klantnr				*	1234	Il s'agit du numéro de client chez ON TIME Logistics. numérique, sans zéros précédents.
1	apipswd				*	c40b0c360f3d4959b53b103b25759542	Mot de passe du compte API
1	omgeving				*	TEST	TEST = Environnement TEST LIVE = Environnement LIVE
1	verzender
	2	contact			*	Ann Flecyn	Nom de la personne qui crée l'ordre 250 caractères maximum
	2	email			*	info@ontime.be	L'adresse électronique de la personne qui crée la commande 250 caractères maximum
	2	referentie			*	dit is een test	Référence générale qui sera mentionnée sur la facture 30 caractères maximum
	2	tel			*	0123546789	Numéro de téléphone de la personne qui crée la commande SANS caractères
	2	prnt			*	CMP	CMP = Les documents seront collectés par nos courriers. ASX = Les pièces jointes seront imprimées immédiatement chez nous
1	webhook						Cette option n'est nécessaire que si vous souhaitez recevoir le suivi automatiquement dès qu'il y a un changement de statut. Pour plus d'informations à ce sujet, consultez la documentation sur les webhooks.
	2	functie				URL	Valeurs possibles: FTP de URL Si vous choisissez FTP, la connexion FTP doit être établie par nos administrateurs.
	2	url				https://www.urlnaaruwscript	n'est nécessaire que si FUNCTIE = URL
	2	methode				POST	Si FUNCTIE = URL => sélectionner POST de GET Si FUNCTIE = XML => sélectionner XML de JSON
	2	email				your@email.be	pas obligatoire, mais si aucune connexion ne peut être établie avec votre fonction webhook ET que cette adresse e-mail est définie, nous vous enverrons un e-mail contenant des informations sur l'état de la situation.
1	opdracht
	2	datum			*	2025-01-14	Date d'exécution de la commande Format AAAA-MM-JJ
	2	middag			*	AM	AM = Matin (jusqu'à 12h00) PM = Après-midi (à partir de 12h00)
	2	expres				1	1 = Traitement et facturation express 0= PAS de traitement express
	2	deadline				16:15	Format de l'heure HH:MM OBLIGATOIRE si express = 1
	2	bestemming				GIP LO	destination de cette mission Valeurs possibles : ANDERE DEPOT ON TIME K1616 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 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 WIJNGAARDNATIE 109 ZONE VENTILATION ON TIME K1616 Si vous souhaitez récupérer des destinations spécifiques à votre numéro de client, utilisez l'API destination : Cliquez ici.
	2	bestemming_ander				ANDERE BESTEMMING	Si vous avez sélectionné
	2	bestemming_adres				SINT ANTONIUSWEG 9	Rue + numéro de destination
	2	bestemming_postcode				9130	Code postal de destination
	2	bestemming_gemeente				Beveren	Municipalité de destination
	2	bestemming_contact				naam van de persoon	Contact de destination
	2	bestemming_tel				0478325678	Numéro de téléphone de destination (numérique)
	2	instructie			*	AFGEVEN L/V	instruction à exécuter pour cette commande Valeurs possibles : AFGEVEN L/V AFSCHRIJVEN ANDERE CHARGER CONTAINER STOCKEREN DOCUMENT(EN) LINKEN IN TUL SYSTEEM DOCUMENTCONTROLE DOCUMENTEN AFGEVEN LOSSEN MONDELINGE VRIJGAVE NAZICHT STOP DE DOUANE VALIDEREN ATR VALIDEREN EUR 1 VERLUCHTEN BIJ ON TIME VERLUCHTINGSZONE K1616 VRACHTLIJST AANZUIVEREN Si vous souhaitez récupérer des instructions spécifiques à votre numéro de client, utilisez l'API d'instructions : Cliquez ici.
	2	instructie_ander				ANDERE INSTRUCTIE	Si vous avez sélectionné
	2	eerstewerk				1	1 = OUI, votre commande sera traitée dans les 2 heures. 0= Non
	2	army				0	À indiquer uniquement s'il s'agit de documents relatifs à la manipulation de matériel de l'armée américaine ou canadienne. 1 = Oui 0= Non
	2	extra			*	3	0 = pas de tâche supplémentaire 1 = mesure du gaz 2 = effectuer une vérification physique 3 = vérification physique + mesure du gaz
	2	extrainfo					Si vous avez saisi une mesure de gaz et/ou une vérification physique, un ou plusieurs champs du bloc ci-dessous doivent être remplis.
		3	tijdstip		*	12:00	obligatoire pour la mesure des gaz ET la vérification physique
		3	verificateur		*	verificateur + ref. magazijn	Informations sur le transporteur, le vérificateur et l'entrepôt de référence obligatoire pour la mesure des gaz ET la vérification physique
		3	gsm		(*)	0478325678	téléphone portable en dehors des heures de bureau (numérique) Uniquement obligatoire en cas de vérification physique
		3	goederen		(*)	Omschrijving van de goederen	UNIQUEMENT obligatoire pour la mesure du gaz
		3	inhoud		*	CONTAINER	Si la mesure du gaz est sélectionnée, la seule valeur possible = CONTAINER Si seulement la vérification physique, Valeurs possibles : CONTAINER ou STUKGOED
	2	containers
		3	container				si 'inhoud = CONTAINER', veuillez indiquer ici tous les numéros de conteneurs
			4	containernr		MSKU1234565
	2	documenten
		3	document				Pour chaque document à traiter, vous pouvez ajouter une étiquette de document. Au moins 1 document requis
			4	type	*	IMA	Valeurs possibles : IMA EXA T2L TRANSIT ANDER
			4	nummer	*	ABCD1234	numéro du document
	2	opmerking				Vrije opmerking
1	les annexes
	2	bijlage
		3	naam			bijlage.pdf	Nom de la pièce jointe
		3	bestand			JVBERi0xLjQKJeLjz9MNCjcgMCBvYmo KPDwKL1R5cGUvWE9iamVjdAovU...	BASE64_encoded

Exemple JSON

Exemple XML

<?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

Vous trouverez ci-dessous la structure utilisée en sortie, ainsi qu'un exemple illustratif et des informations complémentaires pour chaque champ.
Si vous envoyez avec JSON, vous recevrez JSON, idem avec XML.

Niveau/champ				Exemple	Description
1	status			SUCCESS
1	remarks
	2	remark		Er werd 1 opdracht aangemaakt	Commentaires informatifs
1	opdrachten
	2	opdracht
		3	nummer	ASKxxxx	Le numéro de commande
		3	track	https://track.asx.be/xxxxx	Lien vers la page de suivi en ligne
		3	pdf	https://portal.asx.be/pdf/bestelling/?bestelling=zzzzz	Lien vers le formulaire de commande

Niveau/champ			Exemple	Description
1	status		ERROR
1	remarks
	2	remark	foutieve credentials	Liste des erreurs trouvées

Réponse JSON à SUCCESS

Réponse JSON à ERROR

Réponse XML à SUCCESS

<?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>

Réponse XML à 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>

CONTRÔLE/TEST

Grâce à cette fonction, vous pouvez tester n'importe quelle entrée JSON ou XML.
ATTENTION : Cette fonction est TOUJOURS exécutée dans l'environnement TEST.

Votre chaîne INPUT

Le résultat/la réponse :

Transmettre une nouvelle mission KAAI