De Developer Tools stellen je in staat om verzoeken naar de Shipment Server API te testen en op te bouwen. Dit artikel helpt je om aan de slag te gaan.
Je hebt een Portal-login nodig om toegang te krijgen tot de Developer Tools. Neem contact op met nShift Customer Service om een Portal-account te krijgen als je er nog geen hebt.
Ga naar:
Activeren van de Developer Tools
- Log in op nShift Portal.
- Ga naar Ship > Configuration > Settings.
- Scroll naar beneden en vink Show developer tools aan onder de kop New Booking.
- Je hebt nu toegang tot de Developer Tools onderaan alle relevante pagina’s onder New.
Gebruik van de Developer Tools
De sectie Developer Tools heeft twee keuzemenu’s waarin je het label type en de command kunt instellen. Let op dat er verschillende commands beschikbaar zijn afhankelijk van de pagina waarop je je bevindt. Als verzendgegevens nodig zijn in het verzoek, gebruikt de Developer Tools de gegevens die je op de huidige pagina hebt ingevuld. Op deze manier kun je eenvoudig relevante informatie invullen en zien hoe het verzoek eruit zal zien.
Het veld Data toont het verzoek. Sommige commands ondersteunen extra opties die worden toegevoegd in het veld Options. Bekijk onze lijst met methoden hier om te zien welke opties beschikbaar zijn voor elke command. Het veld Response toont het antwoord dat je ontvangt nadat je je verzoek hebt verzonden.
Voorbeeld van het maken van een SubmitShipment-verzoek
De SubmitShipment command maakt een verzending aan en genereert een antwoord met een label.
- Ga naar Ship > New en vul alle velden in die betrekking hebben op de verzending, zoals adresvelden, vervoerder en goedereninformatie.
- In de sectie Developer Tools kies je de SubmitShipment command. Dit toont het verzoek in het Data-veld met behulp van de verzendgegevens die je hebt ingevuld. Je kunt gegevens invullen in referentievelden, berichten, enz., en direct zien hoe deze aan het verzoek worden toegevoegd.
- Klik op de knop Send. Als het verzoek succesvol is, ontvang je een antwoord met het label. Als er iets ontbreekt in het verzoek, ontvang je een foutmelding in het antwoord.
- Klik op de knop View labels om de label(s) van een succesvol SubmitShipment-verzoek te bekijken.
- Gebruik Reformat data als je de gegevens hebt bewerkt of een verzoek in het data-veld hebt geplakt en de gegevens in een beter leesbaar formaat wilt weergeven.
Tip: Als je verzoeken voor Shipment Server bouwt, kun je deze altijd kopiëren en plakken in het Data-veld en testen. Als je verzoek al alle benodigde informatie bevat, hoef je de velden op de pagina niet in te vullen. De gebruikersinterface biedt alleen een eenvoudige manier om te zien hoe gegevens aan een verzoek worden toegevoegd.
Voor meer informatie over Commands, Methods en Options klik hier.
Voor een appendix van objecten en velden klik hier.