ONTIME API Documentatie

CALL

Cette API offre la possibilité de nous envoyer une nouvelle affectation de ville.

URL	https://api.asx.be/STAD/
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	opdrachten
	2	opdracht
		3	datum		*	2025-02-05	Date d'exécution de la commande Format AAAA-MM-JJ
		3	middag		*	AM	AM = Matin (jusqu'à 12h00) PM = Après-midi (à partir de 12h00)
		3	expres			1	1 = Traitement et facturation express 0= PAS de traitement express
		3	deadline			16:15	Format de l'heure HH:MM OBLIGATOIRE si express = 1
		3	instructie		*	AFGEVEN BL	Instruction à exécuter pour cette tâche Valeurs possibles : COURSIER D'ANVERS: ENLèVEMENT ET LIVRAISON DéLIVRANCE D'UNE ATTESTATION / D'UN CERTIFICAT DELIVRANCE PERMIS LE FAIRE APPROUVER BL LIVRERLAISSEZ-SUIVRE RAMASSER ATTESTE / CERTIFICAT RAMASSER B/L RAMASSER BL BLANCO RAMASSER CHEQUE RAMASSER LAISSER SUIVRE RAMASSER POLICE D'ASSURANCE RECUEILLIR WAIVER REMISE BL Si vous souhaitez récupérer des instructions spécifiques à votre numéro de client, utilisez les instructions API : Cliquez ici Cette API indiquera également les champs obligatoires.
		3	bestemming
			4	bedrijf	*	Ontime Logistics	nom de l'entreprise 250 caractères maximum
			4	contact	*	Jean-Claude Van Den Berghe	nom de la personne de contact au sein de l'entreprise 250 caractères maximum
			4	adres1	*	Kattendijkdok 5A	Nom de la rue + Numéro de maison + numéro de bus 250 caractères maximum
			4	adres2			Possibilité d'une deuxième ligne d'adresse 250 caractères maximum
			4	postcode	*	2000	4 caractères maximum
			4	gemeente	*	Antwerpen	250 caractères maximum
			4	tel	*	0471334455	Numéro de téléphone SANS caractères
		3	detail
			4	aantal	*	3	Nombre de documents/colis à traiter pour cette mission Champ numérique
			4	referentie			Référence supplémentaire applicable à cette mission 250 caractères maximum
			4	contbl1		MSKU1234658	Numéro du conteneur / numéro BL 250 caractères maximum Obligatoire pour les instructions suivantes : LE FAIRE APPROUVER BL LIVRERLAISSEZ-SUIVRE RAMASSER B/L RAMASSER LAISSER SUIVRE REMISE BL
			4	contbl2			Numéro du conteneur / numéro BL 250 caractères maximum
			4	contbl3			Numéro du conteneur / numéro BL 250 caractères maximum
			4	contbl4			Numéro du conteneur / numéro BL 250 caractères maximum
			4	contbl5			Numéro du conteneur / numéro BL 250 caractères maximum
			4	contbl6			Numéro du conteneur / numéro BL 250 caractères maximum
			4	contbl7			Numéro du conteneur / numéro BL 250 caractères maximum
			4	contbl8			Numéro du conteneur / numéro BL 250 caractères maximum
			4	contbl9			Numéro du conteneur / numéro BL 250 caractères maximum
			4	contbl10			Numéro du conteneur / numéro BL 250 caractères maximum
			4	haven		Antwerpen KAAI 1759	Nom du port / 250 caractères maximum Obligatoire pour les instructions suivantes : LE FAIRE APPROUVER BL LIVRERLAISSEZ-SUIVRE RAMASSER B/L RAMASSER LAISSER SUIVRE RECUEILLIR WAIVER REMISE BL
			4	schip		Evanna	Nom du navire / 250 caractères maximum Obligatoire pour les instructions suivantes : LE FAIRE APPROUVER BL LIVRERLAISSEZ-SUIVRE RAMASSER B/L RAMASSER LAISSER SUIVRE REMISE BL
			4	opmerking			Note libre pour ce travail 250 caractères maximum
			4	barcode		ABCDEF123456001\|ABCDEF123456002\|ABCDEF123456003	En option, vous pouvez inclure vos propres codes-barres. Si vous le souhaitez, il doit y avoir ici autant de codes-barres que le nombre que vous introduisez dans le bon Les codes-barres se distinguent par un Dans notre exemple, il s'agit de 3 codes-barres. Si vous ne fournissez pas de codes-barres, nous créerons nos propres codes-barres.
1	bijlagen
	2	bijlage
		3	naam			bijlage.pdf	Nom de la pièce jointe
		3	bestand			JVBERi0xLjQKJeLjz9MNCjcgMCBvYmo KPDwKL1R5cGUvWE9iamVjdAovU...	BASE64_encoded

Exemple JSON avec 1 destination

Exemple JSON avec 2 destinations

Exemple XML avec 1 destination

<?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> 
    <opdrachten>
        <opdracht>
            <datum>2020-01-27</datum>
            <middag>AM</middag>
            <expres>1</expres>
            <deadline>16:15</deadline>
            <instructie>AFGEVEN BL</instructie>
            <bestemming>
                <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>
            </bestemming>
            <detail>
                <aantal>3</aantal>
                <referentie>testje</referentie>
                <contbl1>CONTBL voorbeeld</contbl1>
                <contbl2></contbl2>
                <haven>Antwerpen KAAI 1759</haven>
                <schip>Evanna</schip>
                <opmerking></opmerking>
                <handtekening>0</handtekening>
                <betaling></betaling>
                <bedrag></bedrag>
                <munt></munt>
                <chequenr></chequenr>
            </detail>
        </opdracht>
    </opdrachten>
    <bijlagen>
        <bijlage>
            <naam>Bijlage.pdf</naam>
            <bestand>JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU...</bestand>
        </bijlage>
    </bijlagen>
</WebOrder>

Exemple XML avec 2 destinations

<?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> 
    <opdrachten>
        <opdracht>
            <datum>2020-01-27</datum>
            <middag>AM</middag>
            <expres>1</expres>
            <deadline>16:15</deadline>
            <instructie>AFGEVEN BL</instructie>
            <bestemming>
                <bedrijf>Ontime Logistics</bedrijf>
                <contact>Jean-Claude Van Den Berghe</contact>
                <adres1>Kattendijkdok 5A</adres1>
                <adres2></adres2>
                <postcode>2000</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>741258963</tel>
            </bestemming>
            <detail>
                <aantal>5</aantal>
                <referentie></referentie>
                <contbl1>CONTBL voorbeeld</contbl1>
                <contbl2></contbl2>
                <haven>Antwerpen KAAI 1759</haven>
                <schip>Evanna</schip>
                <opmerking></opmerking>
                <handtekening>0</handtekening>
                <betaling></betaling>
                <bedrag></bedrag>
                <munt></munt>
                <chequenr></chequenr>
            </detail>
        </opdracht>
        <opdracht>
            <datum>Bob Dylan</datum>
            <middag>USA</middag>
            <expres>1</expres>
            <deadline>16:15</deadline>
            <instructie>AFGEVEN BL</instructie>
            <bestemming>
                <bedrijf>Ontime Logistics 2</bedrijf>
                <contact>Jean-Claude Van Den Berghe</contact>
                <adres1>Kattendijkdok 5A</adres1>
                <adres2></adres2>
                <postcode>2000</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>987456321</tel>
            </bestemming>
            <detail>
                <aantal>7</aantal>
                <referentie>ref</referentie>
                <contbl1>CONTBL voorbeeld</contbl1>
                <contbl2></contbl2>
                <haven>Antwerpen KAAI 1759</haven>
                <schip>Evanna</schip>
                <opmerking></opmerking>
                <handtekening>0</handtekening>
                <betaling></betaling>
                <bedrag></bedrag>
                <munt></munt>
                <chequenr></chequenr>
            </detail>
        </opdracht>
    </opdrachten>
    <bijlagen>
        <bijlage>
            <naam>Bijlage.pdf</naam>
            <bestand>JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU...</bestand>
        </bijlage>
        <bijlage>
            <naam>Bijlage2.jpg</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	ASXxxxx	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>Er werd een DUBBELE stadsopdracht aangemaakt met 3 subopdrachten</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>

Réponse XML à ERROR

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

Envoyer une nouvelle affectation à une VILLE