ONTIME API Documentatie

CALL

Cette API offre la possibilité de nous envoyer une nouvelle mission nationale ou internationale.

URL	https://api.asx.be/INTNAT/
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
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-02-05	date à laquelle cette commande doit être exécutée Format AAAA-MM-JJ
	2	inhoud			*	BRIEF	Valeurs possibles: BRIEF ou PAKKET
	2	oms			*	verschillende brieven	description des marchandises à collecter
	2	tijdstip					Indiquer l'heure à laquelle l'envoi sera prêt pour l'enlèvement.
		3	van			10:00	uur vanaf
		3	tot			17:00	heure à
	2	brief					à compléter uniquement si le contenu = BRIEF
		3	aantal		*	7	nombre de lettres
		3	gewicht		*	3.0	Le poids en KG de l'envoi total
	2	pakketten					à compléter uniquement si le contenu = PAKKET
		3	pakket
			4	aantal	*	1	nombre d'emballages avec ces dimensions
			4	gewicht	*	0.5	Poids en KG
			4	lengte	*	29	Longueur en CM
			4	breedte	*	29	Largeur en CM
			4	hoogte	*	3	Hauteur en CM
	2	ophaling
		3	bedrijf		*	Ontime Logistics	nom de l'entreprise 250 caractères maximum
		3	adres1		*	Kattendijkdok 5A	Nom de la rue + Numéro de maison + numéro de bus 250 caractères maximum
		3	adres2				Possibilité d'une deuxième ligne d'adresse 250 caractères maximum
		3	postcode		*	2000	4 caractères maximum
		3	gemeente		*	Antwerpen	250 caractères maximum
		3	tel		*	0471334455	Numéro de téléphone SANS caractères
		3	contact		*	Mevr. Spitaels	nom de la personne de contact au sein de l'entreprise
	2	bestemming
		3	bedrijf		*	Ontime Logistics	nom de l'entreprise 250 caractères maximum
		3	adres1		*	Kattendijkdok 5A	Nom de la rue + Numéro de maison + numéro de bus 250 caractères maximum
		3	adres2				Possibilité d'une deuxième ligne d'adresse 250 caractères maximum
		3	postcode		*	2000	4 caractères maximum
		3	gemeente		*	Antwerpen	250 caractères maximum
		3	land			BE	Il s'agit de l'indicatif du pays BE = Belgique, NL = Pays-Bas, FR = France, ... Si le champ est vide, la valeur
		3	tel		*	0471334455	Numéro de téléphone SANS caractères
		3	contact		*	Mevr. Spitaels	nom de la personne de contact au sein de l'entreprise

Exemple JSON avec PACKAGES

Exemple JSON avec LETTRES

Exemple XML avec PACKAGES

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

Exemple XML avec LETTRES

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

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

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-bedrijf 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 :

Envoyer une nouvelle affectation (INTER)NATIONALE