INDHOLDSFORTEGNELSE

• Guide: Opsætning af Generic Forwarder i PeakWMS
  • Hvad er Generic Forwarder?
  • Før I går i gang
  • Funktionens elementer og deres effekt
    • Fragt og fragtprodukter
    • Forbindelse
    • Endpoints
  • Sådan sætter I Generic Forwarder op
  • Test og fejlfinding

Guide: Opsætning af Generic Forwarder i PeakWMS

Hvad er Generic Forwarder?

Generic Forwarder lader jer koble jeres egen labelservice på PeakWMS uden en fragtfirma-specifik integration. I angiver nogle få endpoint-adresser og en nøgle, og PeakWMS sender forsendelsesdata dertil og printer den label, der kommer tilbage.

Funktionen er lavet til den situation, hvor I selv (eller jeres mellemled) allerede danner labels og blot har brug for, at PeakWMS afleverer forsendelsen og får en label retur.

Det kan funktionen:

• Sende forsendelsesdata (afsender, modtager, kolli, referencer og produktindstillinger) til jeres service og printe den returnerede label.
• Håndtere returlabels, annullering af forsendelser og valgfri tracking efter samme mønster.
• Håndtere farligt gods (ADR): jeres service returnerer ADR-transportdokumenter og fareetiketter sammen med labelen, og PeakWMS gemmer og printer dem.
• Køre uden en klient-host: udbyder, nøgle og endpoints ligger direkte på fragtopsætningen i PeakWMS.

Det kan funktionen ikke: vælge pakkeshop og synkronisere et produktkatalog fra et fragtfirma. Det er fravalgt med vilje for at holde opsætningen enkel.

For lagermedarbejderne ser pluk, pak og labelprint ud præcis som med enhver anden fragtintegration.

Før I går i gang

I skal have en modtagende service klar, før opsætningen i PeakWMS giver mening. PeakWMS sender kun data; det er jeres service, der danner labelen.

• En service, der implementerer kontrakten. Jeres udviklere (eller jeres mellemled) bygger endpoints efter dokumentet "PeakWMS API V1 - Generic Forwarder" på api.peakwms.com/api/documentation. Dokumentet viser præcis, hvad hvert endpoint modtager og skal svare.
• Mindst ét endpoint til at oprette fragtlabels. Det er det eneste påkrævede endpoint.
• En godkendelsesnøgle og det skema, nøglen sendes med, som jeres service forventer.
• Et test-endpoint, hvis I vil teste før go-live. Der findes ingen testtilstand i PeakWMS, så test og drift adskilles alene af, hvilke adresser I peger på.
• Adgang til fragtopsætningen under Indstillinger > Integrationer > Fragt i PeakWMS.

Vær opmærksom på feltnavnene. Forespørgslerne følger den publicerede kontrakt: feltnavne starter med lille bogstav (camelCase), landet sendes i feltet country, og pakkeshop sendes kun på forespørgselsniveau. Byg integrationen efter kontrakten, ikke efter ældre eksempler.

Funktionens elementer og deres effekt

Opsætningen består af tre lag: den almindelige fragtopsætning, en forbindelse med nøgle og syv endpoint-adresser. Kun endpointet til fragtlabels er påkrævet; et tomt valgfrit endpoint falder tilbage til en sikker lokal standard i stedet for at kalde ud.

Fragt og fragtprodukter

Forbindelse

Forbindelsen har ingen basisadresse. Hvert endpoint angives med sin fulde adresse.

Endpoints

Det præcise svar, hvert endpoint skal give, står i kontrakten på api.peakwms.com/api/documentation. Fx skal svaret på en fragtlabel indeholde én kolli-post pr. kolli, som gentager kolliets reference fra forespørgslen, med labelen som base64.

Sådan sætter I Generic Forwarder op

Opsætningen foregår under Indstillinger > Integrationer > Fragt. I skal ikke røre klient-host-opsætningen.

1. Opret fragtopsætningen. Gå til Indstillinger > Integrationer > Fragt, opret en ny fragtopsætning og vælg udbyderen Generic.
2. Indtast forbindelsen. Udfyld godkendelsesnøglen og vælg det skema, jeres service forventer.
3. Indtast endpoints. Udfyld den fulde adresse til Opret fragtlabel. Udfyld de valgfrie endpoints for de funktioner, I vil bruge, og lad resten stå tomme.
   • Skal I bruge returlabels, så udfyld Opret returlabel.
   • Skal I bruge tracking, så udfyld Tracking.
4. Opret fragtprodukterne. Tilføj et fragtprodukt for hver fragtmetode og angiv det host-id, der matcher fragtmetoden på de udgående ordrer.
5. Vælg indstillingerne for fragtmetoden. Slå returlabel med fragtlabel, fragtbrev, lastenhed påkrævet, leveringsdato påkrævet og opdeling i flere forsendelser til efter behov.
6. Gem og test. Peg først endpoints på en testservice, og skift til produktionsadresserne, når testen er godkendt (se næste afsnit).

Test og fejlfinding

Den sikreste test er at pege alle endpoints på en request-catcher, fx webhook.site, og se præcis, hvad PeakWMS sender.

1. Peg alle syv endpoints på request-catcheren.
2. Lad catcherens endpoints til fragtlabel og returlabel svare med en label i kontraktens format: én kolli-post, der gentager kolliets reference, med en base64-label.
3. Opret en udgående ordre, hvis fragtmetode matcher et fragtprodukt på fragtopsætningen, og giv leveringsadressen en leveringskommentar.
4. Pluk og pak ordren, og kontrollér at labelen printes, og at data i forespørgslen ser rigtige ud.

Typiske fejl:

Gode råd: Hold test- og produktionsadresser adskilt, så I ved, hvilke adresser der står i feltet. Brug kontrakten som facit, når jeres udviklere bygger servicen.