Kom godt i gang
Når du integrerer med FedEx, kan du nyde godt af de fordele, der kommer med FedEx API'er og webhooks. Disse instruktioner vil guide dig gennem processen for at oprette en organisation, oprette projekter eller komme i gang som en kompatibel bruger.
Trin 1:
Gennemse API'er og webhooks
Du kan starte med at gennemse vores API'er og webhooks for at bestemme dine behov og identificere de bedste løsninger for din applikation.
- Gå til API-kataloget for at begynde at gennemse.
- Vælg en API eller webhook for at læse en oversigt, udforske ændringsloggen og gennemse nøglefunktioner.
- Gennemse dokumentationen for at se flere eksempler på anmodnings- og svarelementer i dit valg af programmeringssprog, fejlkoder og meget mere.
- Se siden Meddelelser for planlagte serviceopdateringer og for at få mere at vide om, hvad der er nyt.
Trin 2:
Tilmeld dig eller log på
Log på med dit fedex.com bruger-ID og din adgangskode for at begynde at integrere FedEx API'er og webhooks.
Hvis du endnu ikke har et bruger-ID, kan du tilmelde dig gratis.
Trin 3:
Opret eller tilmeld dig en organisation.
Du skal enten oprette en organisation, hvis der endnu ikke findes en for din virksomhed, eller tilmelde dig din virksomheds eksisterende organisation.
Sådan oprettes en organisation:
Hvis du opretter en organisation, vil du automatisk blive noteret som administrator for den organisation.
- En administrator kan invitere brugere til at deltage i sin organisation, tildele dem roller (fx bidragsyder eller seer) og projekter og kan administrere forsendelseskonti.
- For at få mere at vide om disse roller kan du se vores Vejledning til organisationsadministration.
For at oprette din egen organisation skal du klikke på Opret organisation i navigationen til venstre.
Angiv organisationsoplysninger
- Angiv navnet på din virksomhed og hjemmesidens URL, og opret et organisationsnavn. Giv din organisation et navn, som andre brugere vil genkende. Dette navn kan bruges til at organisere din virksomhed i mere specifikke grupper (fx: område, afdeling, region, lokation), eller det kan være det samme som navnet på din virksomhed.
Sådan tilmeldes du en organisation:
Du kan tilmelde dig en allerede eksisterende organisation ved at følge disse trin:
- Bed administratoren af din organisation om at sende dig en invitation
- Hvis din virksomhed allerede har oprettet en organisation, skal du bede organisationens administrator om at invitere dig til at deltage. Du har 24 timer til at acceptere invitationen. Hvis du ikke når det indenfor dette tidsrum, kan du bede vedkommende om at sende invitationen igen.
- Acceptér invitationen
- For at acceptere invitationen skal du enten logge på med dit eksisterende bruger-ID og din adgangskode eller oprette et nyt, hvis dit eksisterende bruger-ID allerede er tilknyttet en organisation.
Trin 4:
Tilføj en forsendelseskonto.
- Fuldstændige kontooplysninger
- Indtast dit kundenummer, et hvilket som helst kontokaldenavn og en faktureringsadresse, der er tilknyttet kontoen. Vi validerer derefter faktureringsadressen for at sikre, at den stemmer overens med kontodetaljerne for at forhindre ulovlige aktiviteter.
- For at se forsendelseskonti tilknyttet dit bruger-ID skal du gå til siden Administrer organisation og fanen Forsendelseskonti. Kontakt din FedEx salgsrepræsentant for at oprette nye forsendelseskonti.
- slutbrugerlicensaftale
- Du skal acceptere Slutbruger-licensaftalen (EULA) eller sende den til en anden person indenfor slutbruger-virksomheden, som kan acceptere aftalen. Du kan se status på EULA'en på siden Administrer organisation, under fanen Forsendelseskonto.
Trin 5:
Tilføj brugere til din organisation
En administrator kan invitere brugere til deres organisation og tildele dem roller og projekter. For at komme i gang kan du tilføje brugere fra siden Administrer organisation ved at gennemføre følgende trin (de trin, der er markeret med * er valgfri):
Indtast brugeres e-mailadresser
- Indtast e-mailadresserne på de brugere, som du ønsker at invitere til at tilmelde sig din organisation. Du kan indtaste flere e-mailadresser ved at trykke på mellemrum, komma, semikolon eller enter på dit tastatur mellem adresserne
Vælg brugerroller
- Vælg en anden brugerrolle, hvis standardindstillingen for Fremviser ikke svarer til den brugers behov.*
Tildel brugere til et projekt
- Hvis du allerede har oprettet projekter, kan du tildele brugere til et projekt.*
En administrator vil altid have adgang til alle projekter, men en bidragyder eller seer skal være tildelt et projekt (med mindre en bidragyder opretter et projekt, så denne automatisk er tildelt projektet).
Uanset om en bruger har accepteret invitationen eller ej, kan du hurtigt opdatere vedkommendes projekter eller roller direkte fra siden Administrer organisation under fanen Brugere.
- Klik på cirkumflekset ved siden af rollen eller projektet, så der vises en rullemenu med muligheder.
- Vælg en mulighed, og vælg dernæst knappen Tilføj for at gemme dit valg.
Trin 1:
Opret et projekt for at få legitimationsoplysninger.
En administrator eller bidragyder fra din organisation kan oprette et API-projekt ved at klikke på knappen Opret et API-projekt.
Før du går i gang, skal du fortælle os, hvorfor du har brug for adgang til FedEx API'er. En modal vil vise dig rullemenumulighederne. Du skal vælge den mulighed, der bedst beskriver din virksomheds behov for at integrere med FedEx API'er.
Hvis du er afsender, kan du begynde at oprette dit projekt. Dette er en tre-trins-proces:
- Vælg API'er
Vælg den API, du ønsker at inkludere i dit projekt. Baseret på den API, du vælger, vil du muligvis skulle foretage nogle yderligere valg.
Hvis du vælger APIen Track, skal du også:
- vælge et kundenummer, der skal tilknyttes din produktionsnøgle.
- gennemgå Track APIens kvoter, prisbegrænsninger og API-certificeringsdetaljer.
- Vælg, hvorvidt du ønsker at tilmelde dig e-mails, der vil give dig besked, hvis du overskrider din transaktionskvote.
- Konfigurer projekt
Indtast nogle specifikke detaljer for projektet, som navn og forsendelsesadresse.
- Giv dit projekt et identificérbart navn, der er unikt for din organisation
- Vælg de lande, du planlægger at sende indenfor, så vi kan tildele dig en testkonto til forsendelse. For at kunne teste indenrigs-forsendelser i et europæisk land skal du have en separat testkonto for hvert land. Du kan altid tilføje/fjerne lande senere.
- For at få notifikationer om de seneste API-opdateringer og eventuelle afbrydelser, kan du ændre dine notifikationsindstillinger.
- Bekræft detaljer
Gennemgå dine projektdetaljer, og acceptér vores vilkår og betingelser.
- Læs og acceptér FedEx Developer Portal-licensaftalen, og bekræft, at du ikke har til hensigt at sælge eller distribuere din applikation.
- Når du klikker på knappen "Opret", vil du se en bekræftelsesskærm. Du kan derefter se dine testoplysninger i dit nye projekt.
Trin 2:
Integrér API'er og test din implementering
forsendelseskonto – under fanen Testnøgle. Derefter kan du:
- anmode om en OAuth-adgangstoken, som skal bruges til hver API-transaktion. Tokenet er kun gyldigt i en time, så du bliver nødt til at programmere din applikation for at opdatere tokenet, før sessionen udløber. Se API-godkendelsesdokumenterne for flere detaljer
- klikke på dokumenter til dine API'er for at læse forretningskonteksten for hver API for bedst at forstå, hvordan du bruger den. Du kan også gennemse eksempler på anmodninger for det slutpunkt, der matcher din ønskede integration.
- implementere dine opkald til disse slutpunkter som beskrevet i prøveanmodningerne, og konfigurere dem til med dine testoplysninger.
- kontrollere, at de API-opkaldssvar, du modtager, svarer til dem, der er vist i dokumentationen.
- teste din implementering i FedEx-testmiljøet ved hjælp af dine testoplysninger og FedEx' test-URL'er.
Trin 3:
Flyt dit projekt til produktion
udføre følgende trin.
Indenfor trinnet Konfigurer projekt:
- Du kan omdøbe din nøgle efter behov.
- Gennemse det kundenummer, du valgte i trin 1 af projektoprettelses-flowet. Dette anvendes til at flytte dit projekt til produktion. Når dit projekt er live i produktion, kan du tilføje flere konti efter behov.
Indenfor trinnet Få projektnøgler:
- Din produktions-API-nøgle og hemmelige produktionsnøgle vil blive vist. Sørg for at kopiere dem til et sikkert sted.
- For at holde din hemmelige produktionsnøgle sikker, viser vi den kun én gang. Hvis du mister den, kan du oprette en ny.
- Klik på Næste.
Du vil nu blive omstillet til siden Projektoversigt. Her kan du tilføje flere konti associeret med dit projekt.
På siden Projektoversigt skal du:
- klikke på de tre prikker for at tilføje flere konti associeret med dit projekt.
- klikke på rediger.
Dette vil tage dig til siden API-nøgle, hvor du kan tilføje eventuelle yderligere konti, du ønsker at associere med dette projekts produktionsnøgle.
Trin 4:
Afslut din certificering
- Nogle API'er kræver certificering af forsendelsesetiketten til brug i vores produktionsmiljø. Fuldfør certificeringsprocessen for alle API'er i dit projekt med dette krav.
Når alle API'er er blevet certificeret og aktiveret, skal du opdatere dine API-anmodninger ved at erstatte test-URI'er, nøgler og forsendelseskonti med produktions-URI'er, nøgler og forsendelseskonti.
Test igen din implementering i produktionsmiljøet ved hjælp af eksempeldata.
Vi håber, du vil nyde fordelene ved din nye integration!
Forudsætninger for at oprette et webhook-projekt
- Opret et gyldigt URL i din destinationsapplikation/platform
- Generér sikkerhedstoken
- Test af webhook URL
- Godkend destinations-URL
Opret et webhook-projekt
Forudsætninger for at oprette et webhook-projekt
Trin 1:
Opret et gyldigt URL i din destinationsapplikation/platform
Opret et gyldigt URL på din destinationsapplikation/platform for at modtage godkendelseskoder/-beskeder og notifikationer om tracking af webhookdata fra FedEx.
Krav til URL:
- Inkluderer RFC1918 IP-plads
- Inkluderer fedex.com eller et hvilket som helst af dets underdomæner
- Inkluderer IP-adresser i URL'et (herunder local host, 127.0.0.1)
Trin 2:
Generér sikkerhedstoken
Denne sikkerhedstoken kan bruges som hemmelig nøgle til at godkende og validere oplysninger transmitteret mellem dig (kunden) og FedEx.
Krav til sikkerhedstoken:
- Mindst 25 tegn og maks. 100 tegn
- Ét stort bogstav
- Ét lille bogstav
- 1 numerisk tegn
Trin 3:
Test af webhook URL
Det er valgfrit at teste dit URL, men det kan være et nyttigt trin.
Testning kan give dig en bedre idé om, hvorvidt det URL, du har oprettet i trin 1, er gyldig. Det giver FedEx mulighed for at identificere dit URL og oprette forbindelse til dette for at sende data. Testning kan også give dig et prøvesvar, som kan hjælpe med at kontrollere og bekræfte, hvorvidt du kan behandle de trackingdata, som angives via din applikation. Testning godkender dog ikke dit URL.
Gå til vores webhook-dokumentation for at få mere at vide om, hvordan du tester dit webhook-URL.
Trin 4:
Godkend destinations-URL
Ved brug af HMAC SHA256-hashalgoritmen skal du oprette en godkendelsesproces til at validere de oplysninger, der sendes mellem dit destinations-URL og FedEx.
- Når du klikker på Opret, genererer FedEx en tilfældig udfordringsstreng, som sendes til dig i anmodningen. Du forventes at returnere denne udfordringsstreng til FedEx i svaret.
- Du initialiserer meddelelses-godkendelseskoden (MAC) ved brug af HMAC SHA256-algoritmen/proceduren til at hashe (eller kombinere) challenge string og sikkerhedstoken (eller hemmelig nøgle) til at lave en hash-signatur
- Svar FedEx med challengeString og challengeStringResponse sammen i svaret sammen med HTTP-statuskode 200 (OK) eller 202 (ACCEPTED).
- FedEx vil nu validere udfordringsstrengen og svaret på udfordringsstrengen.
- Når svaret er modtaget af FedEx, vil FedEx validere udfordringsstrengen og respons på udfordringsstrengen (eller HMAC-signaturen genereret tidligere) ved at sammenholde det med challengeString og HMAC-signaturen genereret af FedEx.
- Hvis både "challengeString" og HMAC-signaturer stemmer overens, så er godkendelse og arbejdsgang lykkedes. Hvis ikke, vil godkendelsesprocessen fejle, og en fejlmeddelelse vil blive vist.
Opret et webhook-projekt
Trin 1:
Opret et webhook-projekt for at modtage konfigurerede datanotifikationer.
På siden Mine projekter skal du gå til fanen Webhooks.
En administrator eller bidragyder fra din organisation kan oprette et webhook-projekt ved at klikke på knappen Opret et webhook-projekt.
Før du går i gang, skal du fortælle os, hvorfor du har brug for adgang til FedEx-webhooks. En modal vil vise dig rullemenumulighederne. Du skal vælge den mulighed, der bedst beskriver din virksomheds behov for at integrere med FedEx webhooks.
Hvis du er afsender, kan du begynde at oprette dit projekt ved at følge disse trin:
- Identificér dine forretningsbehov
- Vælg den mulighed, der bedst beskriver, hvorfor din virksomhed ønsker at integrere med FedEx-webhooks.
- Vælg niveau og niveaufunktioner
- Vælg enten et basis- eller avanceret webhook-niveau for dit projekt, baseret på dit projekts behov.
- Du kan altid redigere dit valg af niveau senere.
- Hvert niveau kommer med et månedligt abonnementsgebyr.
- Vælg de funktioner, du ønsker at konfigurere sammen med dit projekt.
- Du kan også redigere dine funktioner senere.
- Konfigurér projektdetaljer
- Giv dit projekt et identificérbart navn
- Angiv forudgenereret destinations-URL og sikkerhedstoken-detaljer, som laves under godkendelse forud for oprettelse.
| Feltnavn | Beskrivelse |
|---|---|
Webhook-projektnavn Destinations-URL |
Dette er et ikke-tomt, unikt webhook-projektnavn og skal ikke gentages i noget andet webhook-projekt.
Dette er URL'et, hvor du vil modtage trackingdata/nyttelast.
|
Sikkerhedstoken |
Dette anvendes som delt hemmelighed til at godkende og validere tracking-webhook-svaret.
|
Datasprog (land) Tracking-type |
Vælg det foretrukne sprog for din oversættelse af trackingdata fra rullemenuen. Vælg den svartype, som trackingdata skal modtages i
|
E-mailadresse |
Angiv en e-mailadresse for at modtage e-mailnotifikationer, når der er ændringer i dit webhook-projekt (fx oprettet, redigeret, annulleret). |
E-mailsprog (land) |
Vælg det foretrukne sprog, på hvilket du ønsker at modtage webhook-notifikationer fra FedEx via e-mail. Her er de understøttede svar for e-mailnotifikationer:
|
- Vælg konti
- Vælg fra en liste over kvalificerede (amerikanske eller canadiske) kundenumre, som du ønsker at tilknytte dit projekt.
5. Bekræft detaljer og acceptér vilkår
- Gennemse dine konfigurerede projektdetaljer.
- Læs og acceptér Developer Portal-licensaftalen, og bekræft, at du ikke har til hensigt at distribuere din applikation.
- Læs og acceptér prisaftalen.
- Når du klikker på knappen Opret projekt:
- Hvis din oprettelsesanmodning blev godkendt og behandlet, vil du blive sendt videre til en bekræftelsesskærm.
- Hvis godkendelsen ikke lykkedes, vil du se en fejlmeddelelse.
- Dit tracking-webhook-projekt vil så have et systemgenereret webhook-ID og vil blive vist med statussen "Aktiv".
- FedEx opretter en kompatibel udbyderorganisation.
- Accepter invitation.
- Inviter brugere til din organisation.
- Vælg de API'er, du har brug for til din løsning.
- FedEx opretter projekt(er).
- Integrer API'er i din applikation, og certificer til det kompatible program.
- FedEx flytter projekt(er) til produktion.
- Opret produktionshemmelig nøgle.
Trin 1:
FedEx opretter en kompatibel udbyderorganisation
- FedEx vil oprette en organisation og derefter invitere et teammedlem til at deltage i organisationen. Denne bruger udpeges som administrator for din organisation.
- Når certificering og integration er udført, kan du nemt sende løsningen til dine kunder.
Trin 2:
Accepter invitation.
- Accepter invitationen for at få adgang til API-integrationsdele og dokumentation. For at acceptere invitationen skal du enten logge ind med dit FedEx-bruger-id og din adgangskode eller oprette nye, hvis du ikke allerede har legitimationsoplysninger.
Trin 3:
Inviter brugere til din organisation.
- Som administrator kan du invitere alle teammedlemmer, der skal have adgang til projektet eller organisationen. Hvis du ønsker at vide mere om de forskellige roller, skal du se Vejledning til organisationsadministration.
- Hvis din organisation allerede er oprettet, skal du bede organisationens administrator eller FedEx om at invitere dig til at deltage. Du har 24 timer til at acceptere deres invitation, men hvis du ikke når det indenfor dette tidsrum, kan du bede dem om at sende invitationen igen.
Trin 4:
Vælg de API'er, du har brug for til din løsning.
Se API-kataloget for at bestemme de rigtige API'er til din løsning. Din FedEx Customer Technology Consultant (CTC) og Compatible Channel Manager kan hjælpe dig med at vælge de rigtige API'er til din løsning efter dine forretningsbehov.
Vælg en API for at se en oversigt, ændre logfiler og nøglefunktioner.
Se dokumentation til API'er for at se anmodnings- og svarelementer, eksempler på dit valgte sprog, fejlobjekter og mere.
Gå tilbage til Salesforce for at udfylde produktinformationsarket (PIW) og angiv de API'er, du gerne vil føje til din løsning.
Trin 5:
FedEx opretter projekt(er).
Når produktinformationsarket (PIW) er godkendt, opretter FedEx dit/dine projekt(er). Hver version af hver af dine løsninger har et separat projekt på FedEx Developer Portal. Hvis en bruger ikke er en administrator i organisationen, skal de inviteres for at se hvert projekt.
Dette er også det tidspunkt, hvor FedEx Compatible-teamet sammen med FedEx CTC og certificeringsteams vil organisere en teknisk demonstration af API'erne sammen med dit team. FedEx-teamet vil diskutere de nye muligheder og funktioner, der er tilgængelige med den version af API'er, du anvender. Teamet vil være i stand til at løse tekniske spørgsmål vedrørende API'er, API-afprøvning og alle processer, der skal afsluttes for at starte processen med 'certificering*' for API'er.
* Certificering – Processen defineret af det FedEx Compatible-program for at opfylde kravene til programoverensstemmelse. Der kræves kompatibel programcertificering for at sikre, at alle kompatible udbydere implementerer, markedsfører og distribuerer FedEx-teknologi til afsendere (kunder) som defineret af FedEx-teknologi og servicestandarder.
Trin 6:
Integrer API'er i din applikation, og certificer til det kompatible program.
- Du har nu adgang til din Test API-nøgle og Test hemmelig nøgle for at starte kørsel af transaktioner. Hent dem fra fanen Testnøgle på siden Projektoversigt.
- For at oprette kundenøgler skal du bruge legitimationsregistrerings-API'en, som kun er en privat API, der findes i API-sektionen i hvert af dine projekter.
- Når du har oprettet et par kundenøgler, skal du fortsætte og anmode om et OAuth-adgangstoken, der skal bruges sammen med hver API-transaktion. Sessionen for denne token er kun gyldig i en time, så du bliver nødt til at programmere din applikation for at opdatere tokenen, før sessionen udløber. Se API-godkendelsesdokumenterne for flere detaljer. Når du ser kodeeksempler, skal du sørge for, at der er valgt "Forhandler" i rullemenuen for eksempler.
- Vælg dokumenter til API'erne på din testtasteside, og læs forretningskonteksten for bedst at forstå, hvordan du bruger det valgte API. Gennemse eksempler på forespørgsler for det slutpunkt, der matcher din ønskede integration.
- Implementér dine opkald til disse slutpunkter som beskrevet i eksempelanmodningerne, og konfigurer dem til at bruge dine testoplysninger.
- Kontrollér, at de modtagne API-opkaldssvar svarer til dem, der er vist i dokumentationen.
- Test din implementering fuldstændigt i FedEx-testmiljøet ved hjælp af testoplysningerne og FedEx' test-URI'er.
- Når du har testet dine løsninger fuldstændig, skal du certificere hver løsning i Salesforce. FedEx vil gennemgå alle de indsendte oplysninger og opdatere dig, når din certificering er godkendt.
Trin 7:
FedEx flytter projekt(er) til produktion.
- FedEx flytter derefter dit/dine projekt(er) til produktion.
- Du vil derefter kunne se din produktions-API-nøgle på fanen Produktionsnøgle på siden Projektoversigt.
Trin 8:
Opret produktionshemmelig nøgle.
- Din produktionshemmelige nøgle skal genereres ved at klikke på linket Generer hemmelig nøgle i kolonnen Hemmelig nøgle.
- Du er nu i stand til at teste din implementering igen i produktionsmiljøet ved hjælp af eksempeldata.
- Vi håber, du vil nyde fordelene ved din nye integration!
