ONTIME API Documentatie

CALL

Cette API permet de nous envoyer une nouvelle mission de sprint.

URL	https://api.asx.be/SPRINT/
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	opdracht
	2	productnr		*	18	numéro unique du produit valeur numérique Si vous souhaitez collecter les produits spécifiquement pour votre numéro de client: Cliquez ici.
	2	voertuignr		*	2	numéro unique du véhicule valeur numérique Si vous souhaitez récupérer des véhicules spécifiques à votre numéro de produit: Cliquez ici.
	2	ordermail		*	info@asx.be	l'adresse électronique à laquelle la confirmation de la commande sera envoyée
	2	vrachtbrief			Vrije opmerking	remarque inscrite sur la lettre de voiture
1	bestemmingen
	2	bestemming
		3	num	*	1	numéro du successeur, à partir de 1 Au moins 2 destinations à saisir
		3	taak	*	1	1 = MISE À JOUR 2 = LIVRER 3 = MISE À JOUR + LIVRER
		3	bedrijf	*	Ontime Logistics	nom de l'entreprise
		3	adres1	*	Kattendijkdok 5	Règle de l'adresse 1
		3	adres2		Oostkaai	Règle de l'adresse 2
		3	land	*	BE	Il s'agit de l'indicatif du pays
		3	postcode	*	2000	code postal
		3	gemeente	*	Antwerpen	municipalité
		3	tel	*	0497123456	Numéro de téléphone SANS caractères
		3	contact	*	Mevrouw Spitaels	nom de la personne de contact au sein de l'entreprise
		3	info		Vrije tekst	Informations complémentaires sur cette destination
		3	datum	(*)	2020-07-14	date à laquelle la Obligatoire pour la destination 1 Les destinations sont effectuées immédiatement et consécutivement l'une après l'autre. Uniquement si vous souhaitez une heure différente, entrez à partir de la destination 2 une autre date, de et à
		3	van	(*)	12:00	temps de Obligatoire pour la destination 1
		3	tot	(*)	16:00	temps jusqu'à ce que Obligatoire pour la destination 1
1	goederen
	2	goed
		3	aantal	*	1	volume de marchandises
		3	type	*	pakket	Valeurs possibles: pakket document pallet ander
		3	gewicht	*	25	Poids en KG
		3	lengte		100	Longueur en CM
		3	breedte		20	Largeur en CM
		3	hoogte		30	Hauteur en CM
		3	info		meubelen	Description des marchandises
		3	ophalen	*	1	NUM de la destination à prendre en charge
		3	leveren	*	2	NUM de la destination à livrer

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>
    </verzender> 
        <opdracht>
            <productnr>18</productnr>
            <voertuignr>2</voertuignr>
            <ordermail>info@asx.be</ordermail>
            <vrachtbrief>deze vrije opmerking komt op de vrachtbrief</vrachtbrief>
        </opdracht>
        <bestemmingen>
            <bestemming>
                <num>1</num>
                <taak>1</taak>
                <bedrijf>Ontime Logistics</bedrijf>
                <adres1>Kattendijkdok 5</adres1>
                <adres2>Oostkaai</adres2>
                <land>BE</land>
                <postcode>2000</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>0497123456</tel>
                <contact>Mevrouw Spitaels</contact>
                <info>letop, de hond bijt</info>
                <datum>2020-07-14</datum>
                <van>12:00</van>
                <tot>16:00</tot>
            </bestemming>
            <bestemming>
                <num>2</num>
                <taak>2</taak>
                <bedrijf>ASX-Ibeco</bedrijf>
                <adres1>De Keizelei 239</adres1>
                <adres2></adres2>
                <land>BE</land>
                <postcode>2001</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>0497123456</tel>
                <contact>Jan Smits</contact>
                <info></info>
                <datum></datum>
                <van></van>
                <tot></tot>
            </bestemming>
        </bestemmingen>
        <goederen>
            <goed>
                <aantal>1</aantal>
                <type>pakket</type>
                <gewicht>25</gewicht>
                <lengte>100</lengte>
                <breedte>20</breedte>
                <hoogte>30</hoogte>
                <info>meubelen</info>
                <ophalen>1</ophalen>
                <leveren>2</leveren>
            </goed>
        </goederen>
</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				xxxx	Le numéro de commande
		3	tracknr				GI3TMNZZFUYTSNJABCD	numéro de suivi unique
		3	pdf				https://portal.asx.be/pdf/bestelling/?bestelling=zzzzz	Lien vers le formulaire de commande
		3	track_url				https://et.asx-ibeco.be/planning/tracktrace.php?trackingnr=GI3TMNZZFUYTSNJABCD	lien vers le suivi
		3	order_rates
			4	order_total_excluding_vat			29.99	montant total hors TVA
			4	order_total_including_vat			29.99	montant total TVA incluse
			4	rates
				5	rate
					6	description	KILOMETERS	description du coût
					6	price	28	le montant de la redevance
		3	haltes
			4	halte
				5	nr		SPR123452020093000197_1	numéro unique de l'arrêt
				5	bedrijf		Ontime Logistics	nom de l'entreprise
				5	adres		Kattendijkdok 4 Oostkaai	adresse complète
				5	postcode		2020	code postal
				5	gemeente		Antwerpen	municipalité

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 opdracht aangemaakt</remark>
    </remarks>
    <opdrachten>
        <opdracht>
            <nummer>195182</nummer>
            <bestelling>SPR123452020093000189</bestelling>
            <tracknr>GI3TMNZZFUYTSNJABCD</tracknr>
            <pdf>https://portal.asx.be/pdf/opdracht/?opdracht=e3173ed8a7123456789</pdf>
            <track_url>https://et.asx-ibeco.be/planning/tracktrace.php?trackingnr=GI3TMNZZFUYTSNJABCD</track_url>
            <order_rates>
                <order_total_excluding_vat>29.99</order_total_excluding_vat>
                <order_total_including_vat>29.99</order_total_including_vat>
                <rates>
                    <rate>
                        <description>KILOMETERS</description>
                        <price>28</price>
                    </rate>
                    <rate>
                        <description>BRANDSTOFTOESLAG</description>
                        <price>0.56</price>
                    </rate>
                    <rate>
                        <description>InterCompany 5%</description>
                        <price>1.43</price>
                    </rate>
                </rates>
            </order_rates>
            <haltes>
                <halte>
                        <nr>SPR123452020093000197_1</nr>
                        <bedrijf>Ontime Logistics</bedrijf>
                        <adres>Kattendijkdok 4 Oostkaai</adres>
                        <postcode>2000</postcode>
                        <gemeente>Antwerpen</gemeente>
                </halte>
                <halte>
                        <nr>SPR123452020093000197_2</nr>
                        <bedrijf>ASX-Ibeco</bedrijf>
                        <adres>straat nr</adres>
                        <postcode>1234</postcode>
                        <gemeente>Roeselare</gemeente>
                </halte>
            </haltes>
        </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 :

Nouvelle commande SPRINT