Deze API biedt de mogelijkheid aan om een nieuwe stadsopdracht naar ons toe te sturen.
URL | https://api.asx.be/STAD/ |
---|---|
METHOD | POST |
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 | * | 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 | 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 | opdrachten | |||||||
2 | opdracht | |||||||
3 | datum | * | 2025-02-05 | Datum dat deze opdracht moet worden uitgevoerd Formaat YYYY-MM-DD |
||||
3 | middag | * | AM | AM = Voormiddag (tot 12:00) PM = Namiddag (vanaf 12:00) |
||||
3 | expres | 1 | 1 = Express-behandeling en -facturering 0= GEEN express-behandeling |
|||||
3 | deadline | 16:15 | Uurformaat HH:MM VERPLICHT indien express = 1 |
|||||
3 | instructie | * | AFGEVEN BL | Instructie die moet worden uitgevoerd voor deze opdracht Mogelijke waarden :
Deze API zal tevens de verplichte velden aanduiden. |
||||
3 | bestemming | |||||||
4 | bedrijf | * | Ontime Logistics | Naam van het bedrijf Max 250 karakters |
||||
4 | contact | * | Jean-Claude Van Den Berghe | Naam van de contactpersoon binnen dit bedrijf Max 250 karakters |
||||
4 | adres1 | * | Kattendijkdok 5A | Straatnaam + Huisnummer + busnummer Max 250 karakters |
||||
4 | adres2 | Eventuele tweede adresregel Max 250 karakters |
||||||
4 | postcode | * | 2000 | Max 4 karakters | ||||
4 | gemeente | * | Antwerpen | Max 250 karakters | ||||
4 | tel | * | 0471334455 | Telefoonnummer ZONDER tekens | ||||
3 | detail | |||||||
4 | aantal | * | 3 | aantal documenten/colli's die moeten verwerkt worden voor deze opdracht Numeriek veld |
||||
4 | referentie | Extra referentie van toepassing op deze opdracht Max 250 karakters |
||||||
4 | contbl1 | MSKU1234658 | Container nummer / BL nummer Max 250 karakters Verplicht bij volgende instructies :
|
|||||
4 | contbl2 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | contbl3 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | contbl4 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | contbl5 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | contbl6 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | contbl7 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | contbl8 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | contbl9 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | contbl10 | Container nummer / BL nummer Max 250 karakters |
||||||
4 | haven | Antwerpen KAAI 1759 | Naam van de haven / Max 250 karakters Verplicht bij volgende instructies :
|
|||||
4 | schip | Evanna | Naam van het schip / Max 250 karakters Verplicht bij volgende instructies :
|
|||||
4 | opmerking | Vrije opmerking voor deze opdracht Max 250 karakters |
||||||
4 | barcode | ABCDEF123456001|ABCDEF123456002|ABCDEF123456003 | Optioneel kan u zelf uw barcodes meegeven. Indien u dit wenst, moeten hier evenveel barcodes komen als het aantal dat u bij opdracht » detail » aantal invult. De barcodes worden onderscheiden door een '|' Met ons voorbeeld hier, zouden dat 3 barcodes moeten zijn. Indien u geen barcodes meegeeft, maken wij zelf onze barcodes aan. |
|||||
1 | bijlagen | |||||||
2 | bijlage | |||||||
3 | naam | bijlage.pdf | Naam van uw bijlage | |||||
3 | bestand | JVBERi0xLjQKJeLjz9MNCjcgMCBvYmo KPDwKL1R5cGUvWE9iamVjdAovU... |
BASE64_encoded |
CREATE info@ontime.be 1234 c40b0c360f3d4959b53b103b25759542 TEST Ann Flecyn info@ontime.be dit is een test 0123456789 CMP 2020-01-27 AM 1 16:15 AFGEVEN BL Ontime Logistics Jean-Claude Van Den Berghe Kattendijkdok 5A 2000 Antwerpen 963214785 3 testje CONTBL voorbeeld Antwerpen KAAI 1759 Evanna 0 Bijlage.pdf JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU...
CREATE info@ontime.be 1234 c40b0c360f3d4959b53b103b25759542 TEST Ann Flecyn info@ontime.be dit is een test 0123456789 CMP 2020-01-27 AM 1 16:15 AFGEVEN BL Ontime Logistics Jean-Claude Van Den Berghe Kattendijkdok 5A 2000 Antwerpen 741258963 5 CONTBL voorbeeld Antwerpen KAAI 1759 Evanna 0 Bob Dylan USA 1 16:15 AFGEVEN BL Ontime Logistics 2 Jean-Claude Van Den Berghe Kattendijkdok 5A 2000 Antwerpen 987456321 7 ref CONTBL voorbeeld Antwerpen KAAI 1759 Evanna 0 Bijlage.pdf JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU... Bijlage2.jpg JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU...
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 | ASXxxxx | Het opdrachtnummer | ||||
3 | track | https://track.asx.be/xxxxx | Link naar de online trackingpagina | ||||
3 | 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 |
SUCCESS Er werd een DUBBELE stadsopdracht aangemaakt met 3 subopdrachten ASDxxxxx https://portal.asx.be/pdf/bestelling/?bestelling=zzzzzzz
ERROR opdracht 1 - datum kan niet in het verleden liggen opdracht 2 - bestemming-bedrijf verplicht in te vullen opdracht 3 - detail-aantal verplicht in te vullen opdracht 3 - detail-contbl1 verplicht in te vullen bij deze instructie
Via deze functie kan u elke JSON of XML input uitproberen.
OPGELET : Deze functie wordt STEEDS in de TEST omgeving uitgevoerd