Serverextensie

Een serverextensie maakt het mogelijk voor 3PL-licentiehouders om extra functionaliteiten toe te voegen aan Webship Online zoals het toevoegen van informatie aan een order die eerst van een ander server moet worden opgehaald of eerst door externe parameters moet worden gevalideerd. Het verschil tussen webhooks een serverextensie is dat Webship Online zal wachten op een antwoord van de aangesproken server voor het verder gaat.

Via Admin > Serverextensie kan de serverextensie ingesteld worden en kunnen serverextensie hooks worden aangemaakt en beheerd.

Serverextensie instellingen

Vooraleer de serverextensie kan gebruikt worden moeten volgende instellingen ingevuld worden:

  • Ingeschakeld: Of de serverextensie ingeschakeld is of niet
  • URL: De URL waarop Webship Online de HTTP requests zal sturen
  • Geheim: Een unieke sleutel die gebruikt wordt om communicatie tussen Webship Online en de serverextensie te beveiligen

Serverextensie hooks

Een serverextensie hook bestaat uit een aanleiding en enkele optionele filters.

Aanleidingen

Voor iedere serverextensie hook moet een aanleiding gekozen worden. Een gebeurtenis waarbij Webship Online een HTTP request stuurt naar een gekozen URL. Enkele belangrijke aanleidingen zijn bijvoorbeeld:

  • Wanneer zendingen geregistreerd worden op een order
  • Wanneer een order bewerkt wordt

Filters

Filters zijn optioneel en kunnen gebruikt worden om te bepalen of Webship Online de serverextensie moet contacteren. Omdat HTTP verkeer tussen Webship Online en de serverextensie even kan duren is het best om dit verkeer zoveel mogelijk te vermijden door bijvoorbeeld enkel voor orders voor bepaalde shops de serverextensie te contacteren.

Wanneer wordt de serverextensie gecontacteerd?

Serverextensie hooks worden altijd uitgevoerd vóór de aanleiding van de hook vastgelegd wordt in de databank. Dit betekent dat wanneer een hook uitgevoerd wordt bij het bewerken van een order de serverextensie (indien nodig) nog aanpassingen kan aanbrengen voor dat order wordt opgeslaan in onze databank.

Voorbeelden

Een serverextensie laat dus toe om een eindeloze reeks aan functionaliteiten toe te voegen aan Webship Online. Enkele goeie voorbeelden:

  • Een voorkeurskoerier instellen op basis van parameters in externe software
  • Verzendlabels op maat toevoegen aan het order die dan door Webship Online kunnen worden afgedrukt

Serverextensies gebruiken

Aangezien het opzetten en gebruiken van een serverextensie software op maat vereist is het best om even contact op te nemen met de ontwikkelaars van Webship Online om alle technische aspecten ervan te bespreken.