Getting started
FedEx Developer Portal erbjuder en uppsättning applikationsprogrammeringsgränssnitt (API:er) för att integrera FedEx i dina applikationer. De här anvisningarna innehåller information om hur du konfigurerar en organisation, skapar ett projekt, testar din integration, flyttar ett projekt till produktion och, i vissa fall, certifierar ditt API.
Typer av användare:
FedEx erbjuder integreringstjänster till tre typer av användare: FedEx avsändare, verifierade programvarulösningar kallade FedEx-kompatibla leverantörer och icke-kompatibla leverantörer.
FedEx-avsändare:
Företag som skickar med FedEx och behöver integrera FedEx API:er i sina egna applikationer.
Lösning eller tjänsteleverantör:
Företag som behöver integrera med FedEx API:er för att bygga en lösning, applikation eller plugin som kan säljas och/eller distribueras till en extern organisation som skickar med FedEx. Ta reda på om ditt företag är en verifierad FedEx-leverantör genom att söka i vår globala katalog.
- FedEx-kompatibel leverantör: Verifierat företag med ett avtal genom programmet för FedEx-kompatibla leverantörer.
- Icke-kompatibel leverantör: Lösningen eller tjänsten är inte verifierad av programmet för FedEx-kompatibla leverantörer.
Välj det alternativ nedan som beskriver din verksamhet bäst. Det finns en upplevelse för dig, oavsett användartyp.
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company certified by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- Non-Compatible Provider: Company who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
Prerequisite
You must have a FedEx user ID to log into the FedEx Developer Portal and create an organization.
Du kan antingen skapa en organisation om det inte redan finns en för ditt företag eller gå med i företagets befintliga organisation.
Skapa en ny organisation
Klicka på Skapa organisation i den vänstra menyn för att skapa din egen organisation. Om du skapar en organisation kommer du automatiskt att listas som organisationens administratör.
- En administratör kan bjuda in användare till sin organisation, tilldela roller (t.ex. deltagare eller läsare) och projekt till användarna samt hantera försändelsekonton.
- Mer information om de olika rollerna finns i våra riktlinjer för organisationsadministration.
Tillhandahålla organisationsinformation
Ange företagsnamn och webbplats-URL samt skapa ett organisationsnamn. Ge organisationen ett namn som andra användare kommer att känna igen. Namnet kan användas för att organisera företaget i mer specifika grupper (t.ex. avdelning, division, region och plats) eller kan vara detsamma som företagsnamnet.
När du har skapat organisationen kan du som administratör klicka på Hantera organisation i den vänstra menyn för att ange mer information.
Lägg till ett försändelsekonto
Öppna fliken Försändelsekonton. Klicka på knappen Lägg till konto.
- Ange ditt befintliga FedEx-kontonummer, kontots alias och din faktureringsadress som är kopplad till kontot. Vi kommer att validera faktureringsadressen för att säkerställa att den stämmer överens med kontouppgifterna för att förhindra bedrägerier. Om du inte har något befintligt FedEx-konto kan du öppna ett nytt konto eller kontakta din kundrepresentant hos FedEx.
- Godkänn slutanvändaravtalet eller skicka det till någon inom företaget som har behörighet att godkänna avtalet.
Lägg till ett faktureringskonto
Öppna fliken Faktureringskonton. Klicka på knappen Lägg till ett faktureringskonto i din organisation.
- Ange ditt befintliga FedEx-kontonummer, kontots alias och din USA-baserade faktureringsadress som är kopplad till kontot. Vi kommer att validera faktureringsadressen för att säkerställa att den stämmer överens med kontouppgifterna för att förhindra bedrägerier. Om du inte har något befintligt FedEx-konto kan du öppna ett nytt konto eller kontakta din kundrepresentant hos FedEx. Faktureringskonton måste vara baserade i USA.
- Godkänn slutanvändaravtalet eller skicka det till någon inom företaget som har behörighet att godkänna avtalet.
Bjud in användare
En administratör kan bjuda in användare till sin organisation och tilldela roller och projekt till användarna. Öppna fliken Användare. Klicka på knappen Lägg till användare.
- Välj en användarroll: läsare, deltagare eller administratör.
- Om du har befintliga projekt tilldelar du ett projekt till användaren. Du kan även tilldela användare till projekt på alla översiktssidor för projekt.
- Ange e-postadresserna till användarna som du vill ska gå med i din organisation under den valda rollen.
Gå med i en befintlig organisation
Steg 1: Be organisationens administratör att skicka en inbjudan till dig
Om ditt företag redan har skapat en organisation kan du be organisationens administratör att bjuda in dig. Du har 24 timmar på dig att acceptera inbjudan. Om du skulle missa att göra det kan du be administratören att skicka inbjudan igen.
Steg 2: Acceptera inbjudan
För att kunna acceptera inbjudan måste du antingen logga in med ditt befintliga användar-ID och lösenord eller skapa ett nytt konto, om ditt befintliga användar-ID redan är kopplat till en annan organisation.
Skapa ett API-projekt
Gå till sidan Mina projekt och öppna fliken API:er. Klicka på knappen Skapa API-projekt.
Steg 1: Välj det eller de API:er som du vill inkludera i projektet
Granska API-kvoterna, anropsbegränsningarna och API-certifieringsuppgifterna.
Steg 2: Konfigurera projektuppgifter
- Ge projektet ett identifierbart namn som är unikt för organisationen.
- Välj de länder som du planerar att skicka försändelser i, så skapar vi ett testkonto. Om du vill kunna testa inrikes försändelser av paket i ett europeiskt land måste du ha ett separat testkonto för varje land. Du kan alltid lägga till/ta bort länder vid ett senare tillfälle.
- Välj aviseringsinställningar för att få information om de senaste API-uppdateringarna och eventuell avbrottsrelaterad information.
Steg 3: Läs och godkänn villkoren, inklusive licensavtalet för FedEx Developer Portal
En bekräftelseskärm visas när du har godkänt villkoren och klickat på knappen Skapa. Du kan därefter visa dina autentiseringsuppgifter för tester i det nya projektet.
Skapa ett webbhookprojekt
Prerequisites
- Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
- Set up accounts: Advanced Integrated Visibility webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.
Skapa en giltig URL (ett återanrop) i din destinationsapplikation eller på din destinationsplattform
Din destinations-URL kommer att användas för att ta emot autentiseringskoder och meddelanden samt aviseringar om webhooksbelastning från FedEx. Din URL måste använda HTTPS för att säkerställa säkerheten. Din URL kommer att blockeras om den innehåller något av följande:
- Plats för RFC1918 i IP-adressen
- fedex.com eller någon av dess underdomäner
- Alla med IP-adresser i URL:en (inklusive localhost, 127.0.0.1)
Skapa en säkerhetstoken
Den här säkerhetstoken kan användas som en hemlig nyckel för att autentisera och validera information som överförs mellan din organisation och FedEx. Din säkerhetstoken måste innehålla följande:
- Minst 26 tecken och högst 100 tecken
- En stor bokstav
- En liten bokstav
- Ett numeriskt tecken
Exempel: Y1F6OiVUQW2JPSElmRE9U0IY5
När du har angett en URL och säkerhetstoken är du redo att skapa ett webhookprojekt. Gå till sidan Mina projekt och öppna fliken Webhookar. Klicka på knappen Skapa ett webhookprojekt.
Välj prenumerationstyp
FedEx-avsändare kan få konto- eller spårningsnummer att prenumerera på deras händelser.
Steg 1: Bekräfta faktureringskontot och välj funktioner
- Granska standardfaktureringskontot som anges för att bekräfta eller välj ett annat konto från din organisation.
- Konfigurera ditt projekt genom att välja funktioner som alternativ för leveransbevis, alternativ för beräknad leverans, spårningshändelser och händelsebaserad filtrering.
Steg 2: Ange projektinformation
- Ge projektet ett identifierbart namn som är unikt för organisationen.
- Ange information om din destinations-URL och säkerhetstoken som du skapade under autentiseringen (se stegen ovan).
- Ange en e-postadress och föredraget språk för att få information om de senaste webhookuppdateringarna och eventuell avbrottsrelaterad information.
Steg 3: Läs och godkänn villkoren
En bekräftelseskärm visas när du har godkänt villkoren, inklusive licensavtalet för FedEx Developer Portal och orderformuläret, och klickat på knappen Skapa.
Det kan förekomma fler steg, beroende på ditt val av prenumerationstyp. Du hittar mer information i dokumentationen.
Hämta dina autentiseringsuppgifter för tester–API-nyckel, hemlig nyckel och försändelsekonton – på fliken Testnyckel på sidan API-projektöversikt.
Steg 1: Begär en OAuth-åtkomsttoken
OAuth-åtkomsttoken måste användas med varje API-transaktion. Token är endast giltig i en timme, så du måste programmera applikationen att uppdatera token innan sessionen upphör att gälla. Mer information finns i dokumentationen om auktorisering av API:er.
Steg 2: Granska API-dokumentationen
Klicka på dokumentationen för varje API för att läsa företagskontexten och få en förståelse för hur API:et används. Logga in för att ladda ner JSON API-sviten via knappen högst upp på dokumentationssidan. Du kan även granska exempelbegärandena för slutpunkten som matchar den önskade integreringen.
Steg 3: Använd sandlådemiljön för att testa exempeltransaktioner
Klicka på önskad slutpunkt i den vänstra menyn för att gå till den specifika sandlådemiljön. Identifiera de exempelbegäranden som matchar ditt användningsfall och använd därefter dina autentiseringsuppgifter för tester och FedEx test-URL:er för att implementera dina anrop till slutpunkten på det sätt som beskrivs i exempelbegärandena. Verifiera att svaren på API-anropen stämmer överens med de som visas i dokumentationen. Läs mer om vår testupplevelse i guiden för virtualisering i sandlådemiljö.
Testa med webhookar
Tester kan bidra till att få en bättre uppfattning om huruvida URL:en som du skapade är giltig. Det gör det möjligt för FedEx att identifiera din URL och upprätta en anslutning till URL:en för att skicka data. Tester kan även tillhandahålla exempeltestdata som kan hjälpa dig att kontrollera och bekräfta om du kan behandla spårningsdata som tillhandahålls i din applikation. Testerna autentiserar däremot inte din URL. Läs mer om hur du testar din webbhook-URL i vår webbhookdokumentation.
Gå till sidan Projektöversikt och öppna fliken Produktionsnyckel. Projekt med Advanced Integrated Visibility-prenumeration på kontonummer behöver inte flyttas till produktion.
Steg 1: Konfigurera projektet
- Byt namn på nyckeln efter behov.
- Kontrollera kontonumret som du valde i steg 1 av projektskapandet. Det används för att flytta projektet till produktionsmiljön. När projektet är under produktion kan du lägga till fler konton efter behov.
Steg 2: Hämta projektnycklar
Spara din API-produktionsnyckel och hemliga produktionsnyckel på en säker plats. Av säkerhetsskäl visar vi bara din hemliga nyckel en gång. Om du tappar bort den kan du skapa en ny.
När du har hämtat dina projektnycklar och klickat på Nästa visas din projektinformation på fliken Produktionsnyckel.
- Klicka på Redigera högst upp i försändelsekontotabellen för att lägga till fler försändelsekonton i ditt projekt.
Certification steps vary by region
The following steps apply only for customers in the US and Canada. If you live outside of these countries, visit the API Certification page to find support.
Vissa API:er kräver certifiering av försändelseetikett om de ska användas i vår produktionsmiljö. Se om ditt API kräver certifiering.
Steg 1. Utveckla och testa FedEx API:er med ditt onlinebaserade program
När du har utvecklat ett onlinebaserat program är det dags att slutföra testningen med autentiseringsuppgifterna för testmiljön (konton, API-nyckeln och den hemliga nyckeln för testmiljön). Testmiljöns API-nyckel och hemliga nyckel är alltid tillgängliga på sidan Projektöversikt.
Steg 2: Flytta projektet till produktionsmiljön
När du har testat med FedEx API:er kan du börja certifieringsprocessen genom att flytta projektet till produktionsmiljön på FedEx Developer Portal. Du kan visa API-nyckeln och den hemliga nyckeln för produktionsmiljön när du har gjort det. Du kan endast visa den hemliga nyckeln för produktionsmiljön en gång, men du kan skapa en ny vid ett senare tillfälle.
Steg 3: Fyll i etikettens försättsblad
Fyll i hela etikettens försättsblad med lämpliga kontaktuppgifter och de tjänster som du planerar att implementera. Ange kontonumret och produktionsnyckeln.
Steg 4: Skapa och skicka in testetiketter till streckkodsteamet
Skapa testetiketter i den FedEx-testmiljö som är associerad med applikationen och skicka sedan testetiketterna till FedEx utvärderingsteam för godkännande. Streckkodsteamet behöver tre arbetsdagar på sig för att utvärdera en etikett.
Följ denna bästa praxis för att undvika förseningar:
- Etiketterna måste skrivas ut och skannas med minst 600 DPI. SKICKA INTE FILER SOM SKAPATS AV API:ER.
- Om du använder en termoskrivare måste etikettens bildtyp begäras i enlighet med skrivarmodellen. Exempel: ZPLII for Zebra-skrivare.
- Använd avsändar-/mottagaradressinformation när du skapar provetiketter för utvärdering. Skapa endast provetiketter för de specifika tjänster som du ansöker om.
- Etiketten för FedEx® postförskott (C.O.D.) måste även ha motsvarande returetikett för C.O.D.
- FedEx International Express®-försändelser måste även ha en fraktsedelsetikett (AWB) i reserv.
- Flerkolliförsändelser måste ha en etikett för varje paket i försändelsen.
- Skicka PDF:n och etikettens försättsblad med e-post till label@fedex.com.
- Fysiska etiketter ska skickas till nedanstående adress:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
De skannade etiketterna kan endast godkännas om de inte har några synliga defekter (t.ex. linjer som går genom streckkoden, fläckar i bläcket eller fysiska skador).
Var uppmärksam på utskriftskvaliteten och oavsiktlig förstoring/förminskning av etiketterna (dvs. skalning) om du skickar etiketter via e-post. Det är de vanligaste anledningarna till varför etiketter inte godkänns.
Steg 5: Granska etikettutvärderingen
Teamet som godkänner streckkoder kommer att utvärdera de inskickade testetiketterna och godkänna eller avslå dem. Streckkodsteamet kommer att kontakta dig angående de inskickade etiketterna. Gå vidare till nästa steg om etiketterna godkänns. Om etiketterna avslås ska du korrigera dem enligt anvisningarna och skicka in dem för godkännande igen.
Steg 6: Aktivera applikationen
När testetiketterna har godkänts för produktionsstatus kommer streckkodsteamet att godkänna dina produktionsautentiseringsuppgifter för att överföra den identifierade etiketten och meddela dig att certifieringen har godkänts via e-post. Godkännandet gäller endast för det specifika projektet.
Steg 7: Ersätt URL:en och autentiseringsuppgifterna
Ersätt testmiljöns URL och autentiseringsuppgifter med produktionsmiljöns URL och autentiseringsuppgifter. Testa implementeringen igen i produktionsmiljön med hjälp av exempeldata.
Prerequisite
Your business must be an existing FedEx Compatible provider. If your business is not in the Compatible program, then change your selection above to “Non-Compatible Provider.”
Steg 1: Få en inbjudan att gå med i en organisation
FedEx kommer att skapa en organisation och därefter bjuda in en teammedlem att gå med i organisationen. Den användaren kommer att bli administratör för din organisation.
Steg 2: Acceptera inbjudan
För att kunna acceptera inbjudan måste du antingen logga in med ditt befintliga användar-ID och lösenord eller skapa ett nytt konto, om ditt befintliga användar-ID redan är kopplat till en annan organisation.
Steg 3: Bjud in användare
En administratör kan bjuda in användare till sin organisation och tilldela roller och projekt till användarna. Öppna fliken Användare. Klicka på knappen Lägg till användare.
- Välj en användarroll: läsare, deltagare eller administratör. Läs mer om roller i vår guide för organisationsadministration.
- Om du har befintliga projekt tilldelar du ett projekt till användaren. Du kan även tilldela användare till projekt på alla översiktssidor för projekt.
- Ange e-postadresserna till användarna som du vill ska gå med i din organisation under den valda rollen.
Gå till API-katalogen för att välja lämpliga API:er eller webhookar för din lösning. Din FedEx Customer Technology Consultant (CTC) och Compatible Channel Manager kan hjälpa till att välja rätt API:er för din lösning utifrån företagets behov.
Steg 1: Fyll i PIW
Gå tillbaka till Compatible Provider Community (CPC) för att fylla i Product Information Worksheet (PIW).
Steg 2: Granska projektet eller projekten som FedEx har skapat
När PIW har godkänts kommer FedEx att skapa dina projekt. Varje version av varje lösning kommer att ha ett separat projekt i FedEx Developer Portal.
Steg 3: Delta i API-demostrationen med ditt team
FedEx Compatible-teamet kommer att hålla en teknisk demonstration om API:erna för ditt team tillsammans med FedEx CTC- och certifieringsteamen. FedEx-teamet kommer att diskutera Compatible Program Verification och nya API-funktioner samt svara på frågor.
Hämta dina autentiseringsuppgifter för tester–API-nyckel och hemlig nyckel – på fliken Testnyckel på sidan API-projektöversikt.
Steg 1: Skapa kundnycklar
Använd Credential Registration API för att skapa kundnycklar. Det här är ett privat API som du bara hittar i API-avsnittet längst ner på sidan API-projektöversikt.
Steg 2: Begär en OAuth-åtkomsttoken
OAuth-åtkomsttoken måste användas med varje API-transaktion. Token är endast giltig i en timme, så du måste programmera applikationen att uppdatera token innan sessionen upphör att gälla. Mer information finns i dokumentationen om auktorisering av API:er. Se till att välja Återförsäljare i listrutan när du visar exempelkoden.
Steg 3: Granska API-dokumentationen
Klicka på dokumentationen för varje API för att läsa företagskontexten och få en förståelse för hur API:et används. Logga in för att ladda ner JSON API-sviten via knappen högst upp på dokumentationssidan. Du kan även granska exempelbegärandena för slutpunkten som matchar den önskade integreringen.
Steg 4: Använd sandlådemiljön för att testa exempeltransaktioner
Klicka på önskad slutpunkt i den vänstra menyn för att gå till den specifika sandlådemiljön. Identifiera de exempelbegäranden som matchar ditt användningsfall och använd därefter dina autentiseringsuppgifter för tester och FedEx test-URL:er för att implementera dina anrop till slutpunkten på det sätt som beskrivs i exempelbegärandena. Verifiera att svaren på API-anropen stämmer överens med de som visas i dokumentationen. Läs mer om vår testupplevelse i guiden för virtualisering i sandlådemiljö.
Steg 5: Verifiera varje lösning
När du har testat dina lösningar är det dags att skicka in testfallen till verifieringsteamet för att verifiera varje lösning. FedEx kommer att granska allt som du skickar in och uppdatera när din verifiering är godkänd.
Testa med webhookar
Om din organisation har åtkomst till webhookar kan tester hjälpa dig att få en bättre uppfattning om huruvida URL:en som du skapade är giltig. Det gör det möjligt för FedEx att identifiera din URL och upprätta en anslutning till URL:en för att skicka data. Tester kan även tillhandahålla exempeltestdata som kan hjälpa dig att kontrollera och bekräfta om du kan behandla spårningsdata som tillhandahålls i din applikation. Testerna autentiserar däremot inte din URL. Läs mer om hur du testar din webbhook-URL i vår webbhookdokumentation.
FedEx kommer därefter att flytta ditt eller dina projekt till produktion. Gå till sidan API-projektöversikt och öppna fliken Produktionsnyckel. Klicka på länken Skapa hemlig nyckel under kolumnen Hemlig nyckel.
Nu kan du testa implementeringen igen i produktionsmiljön med hjälp av exempeldata.
Prerequisite
You must have a FedEx user ID and account to log into the FedEx Developer Portal and create an organization.
Du kan antingen skapa en organisation om det inte redan finns en för ditt företag eller gå med i företagets befintliga organisation.
Skapa en ny organisation
Klicka på Skapa organisation i den vänstra menyn för att skapa din egen organisation. Om du skapar en organisation kommer du automatiskt att listas som organisationens administratör.
- En administratör kan bjuda in användare till sin organisation och tilldela roller (t.ex. deltagare eller läsare) och projekt till användarna.
- Mer information om de olika rollerna finns i vår guide för organisationsadministration.
Steg 1: Tillhandahåll organisationsinformation
- Ange ditt företags namn, webbplats-URL och e-postadress som användes i arbetet för verifiering.
- Skapa ett organisationsnamn. Ge organisationen ett namn som andra användare kommer att känna igen. Namnet kan användas för att organisera företaget i mer specifika grupper (t.ex. avdelning, division, region och plats) eller kan vara detsamma som företagsnamnet.
- Ange information om platserna där ditt företag är baserad och där du planerar att sälja eller distribuera din programvarulösning.
Steg 2: Lägg till och autentisera ett konto
Ange ditt befintliga FedEx-kontonummer, kontots alias och din faktureringsadress som är kopplad till kontot. Vi kommer att validera faktureringsadressen för att säkerställa att den stämmer överens med kontouppgifterna för att förhindra bedrägerier. Om du inte har något befintligt FedEx-konto kan du öppna ett nytt konto eller kontakta din kundrepresentant hos FedEx.
- När en tredjepartsleverantör går med i FedEx Integrator Program måste kontot som används för den initiala registreringen tillhöra dig som integrator. Det är inte tillåtet att använda ett slutkundskonto.
- Det här kontot kommer att ställas in som standardfaktureringskonto för din organisation.
Steg 3: Läs och godkänn villkoren
En bekräftelseskärm visas när du har godkänt utvecklaravtalet och programhandböckerna. Som administratör för din nya organisation kan du därefter klicka på Hantera organisation i den vänstra menyn för att visa eller redigera information.
Steg 4: Bjud in användare
En administratör kan bjuda in användare till sin organisation och tilldela roller och projekt till användarna. Öppna fliken Användare. Klicka på knappen Lägg till användare.
- Välj en användarroll: läsare, deltagare eller administratör.
- Om du har befintliga projekt tilldelar du ett projekt till användaren. Du kan även tilldela användare till projekt på alla översiktssidor för projekt.
- Ange e-postadresserna till användarna som du vill ska gå med i din organisation under den valda rollen.
Gå med i en befintlig organisation
Steg 1: Be organisationens administratör att skicka en inbjudan till dig
Om ditt företag redan har skapat en organisation kan du be organisationens administratör att bjuda in dig. Du har 24 timmar på dig att acceptera inbjudan. Om du skulle missa att göra det kan du be administratören att skicka inbjudan igen.
Steg 2: Acceptera inbjudan
För att kunna acceptera inbjudan måste du antingen logga in med ditt befintliga användar-ID och lösenord eller skapa ett nytt konto, om ditt befintliga användar-ID redan är kopplat till en annan organisation.
Gå till sidan Mina projekt och öppna fliken API:er. Klicka på knappen Skapa API-projekt.
Steg 1: Välj det eller de API:er som du vill inkludera i projektet
Granska kvoterna, anropsbegränsningarna och API-certifieringsuppgifterna för Ship API, Rate API och andra API:er.
- Om du väljer Ship API eller Open Ship API kommer Service Availability API och Trade Documents Upload API att väljas automatiskt, eftersom de är nödvändiga API:er som måste användas när Ship API eller Open Ship API används.
Steg 2: Konfigurera projektuppgifter
Ge projektet ett identifierbart namn som är unikt för organisationen.
Steg 3: Läs och godkänn villkoren, inklusive licensavtalet för FedEx Developer Portal
En bekräftelseskärm visas när du har godkänt villkoren och klickat på knappen Skapa. Du kan därefter visa dina autentiseringsuppgifter för tester i det nya projektet.
Skapa ett webbhookprojekt
Prerequisites
- Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
- Set up accounts: Shipment Visibility webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.
Skapa en giltig URL (ett återanrop) i din destinationsapplikation eller på din destinationsplattform
Din destinations-URL kommer att användas för att ta emot autentiseringskoder och meddelanden samt aviseringar om webhooksbelastning från FedEx. Din URL måste använda HTTPS för att säkerställa säkerheten. Din URL kommer att blockeras om den innehåller något av följande:
- Plats för RFC1918 i IP-adressen
- fedex.com eller någon av dess underdomäner
- Alla med IP-adresser i URL:en (inklusive localhost, 127.0.0.1)
Skapa en säkerhetstoken
Den här säkerhetstoken kan användas som en hemlig nyckel för att autentisera och validera information som överförs mellan din organisation och FedEx. Din säkerhetstoken måste innehålla följande:
- Minst 26 tecken och högst 100 tecken
- En stor bokstav
- En liten bokstav
- Ett numeriskt tecken
Exempel: Y1F6OiVUQW2JPSElmRE9U0IY5
När du har angett en URL och säkerhetstoken är du redo att skapa ett webhookprojekt. Gå till sidan Mina projekt och öppna fliken Webhookar. Klicka på knappen Skapa ett webhookprojekt.
Välj prenumerationstyp
FedEx-avsändare kan få konto- eller spårningsnummer att prenumerera på deras händelser.
Steg 1: Bekräfta faktureringskontot och välj funktioner
- Granska standardfaktureringskontot som anges för att bekräfta eller välj ett annat konto från din organisation.
- Konfigurera ditt projekt genom att välja funktioner som alternativ för leveransbevis, alternativ för beräknad leverans, spårningshändelser och händelsebaserad filtrering.
Steg 2: Ange projektinformation
- Ge projektet ett identifierbart namn som är unikt för organisationen.
- Ange information om din destinations-URL och säkerhetstoken som du skapade under autentiseringen (se stegen ovan).
- Ange en e-postadress och föredraget språk för att få information om de senaste webhookuppdateringarna och eventuell avbrottsrelaterad information.
Steg 3: Läs och godkänn villkoren
En bekräftelseskärm visas när du har godkänt villkoren, inklusive licensavtalet för FedEx Developer Portal och orderformuläret, och klickat på knappen Skapa.
Det kan förekomma fler steg, beroende på ditt val av prenumerationstyp. Du hittar mer information i dokumentationen.
Hämta dina autentiseringsuppgifter för tester–API-nyckel och hemlig nyckel – på fliken Testnyckel på sidan API-projektöversikt.
Steg 1: Begär en OAuth-åtkomsttoken
OAuth-åtkomsttoken måste användas med varje API-transaktion. Token är endast giltig i en timme, så du måste programmera applikationen att uppdatera token innan sessionen upphör att gälla. Mer information finns i dokumentationen om auktorisering av API:er.
Steg 2: Granska API-dokumentationen
Klicka på dokumentationen för varje API för att läsa företagskontexten och få en förståelse för hur API:et används. Logga in för att ladda ner JSON API-sviten via knappen högst upp på dokumentationssidan. Du kan även granska exempelbegärandena för slutpunkten som matchar den önskade integreringen.
Steg 3: Använd sandlådemiljön för att testa exempeltransaktioner
Klicka på önskad slutpunkt i den vänstra menyn för att gå till den specifika sandlådemiljön. Identifiera de exempelbegäranden som matchar ditt användningsfall och använd därefter dina autentiseringsuppgifter för tester och FedEx test-URL:er för att implementera dina anrop till slutpunkten på det sätt som beskrivs i exempelbegärandena. Verifiera att svaren på API-anropen stämmer överens med de som visas i dokumentationen. Läs mer om vår testupplevelse i guiden för virtualisering i sandlådemiljö.
Testa med webhookar
Om din organisation har åtkomst till webhookar kan tester hjälpa dig att få en bättre uppfattning om huruvida URL:en som du skapade är giltig. Det gör det möjligt för FedEx att identifiera din URL och upprätta en anslutning till URL:en för att skicka data. Tester kan även tillhandahålla exempeltestdata som kan hjälpa dig att kontrollera och bekräfta om du kan behandla spårningsdata som tillhandahålls i din applikation. Testerna autentiserar däremot inte din URL. Läs mer om hur du testar din webbhook-URL i vår webbhookdokumentation.
Gå till sidan Projektöversikt och öppna fliken Produktionsnyckel. Projekt med Advanced Integrated Visibility-prenumeration på kontonummer behöver inte flyttas till produktion.
Steg 1: Konfigurera projektet
Byt namn på nyckeln efter behov.
Steg 2: Hämta projektnycklar
Spara din API-produktionsnyckel och hemliga produktionsnyckel på en säker plats. Av säkerhetsskäl visar vi bara din hemliga nyckel en gång. Om du tappar bort den kan du skapa en ny.
När du har hämtat dina projektnycklar och klickat på Nästa visas din projektinformation på fliken Produktionsnyckel.
Certification steps vary by region
The following steps apply only for customers in the US and Canada. If you live outside of these countries, visit the API Certification page to find support.
Vissa API:er kräver certifiering av försändelseetikett om de ska användas i vår produktionsmiljö. Se om ditt API kräver certifiering.
Steg 1. Utveckla och testa FedEx API:er med ditt onlinebaserade program
När utvecklingen av din onlinebaserade applikation är klar är det dags att slutföra testningen med autentiseringsuppgifterna för tester (API-nyckeln och den hemliga nyckeln). Testmiljöns API-nyckel och hemliga nyckel är alltid tillgängliga på sidan Projektöversikt.
- Identifiera alla testfall för de regioner/områden där du vill validera och distribuera din lösning. Du hittar testfallen här.
- Innan du kör testfallen måste du köra registreringstransaktionerna för respektive testkontonummer.
- Kör därefter alla testfall för de regioner/områden där du vill validera och distribuera din lösning.
Steg 2: Fyll i PIW och Validation Cover Sheet
Fyll i kontaktuppgifter och vilka tjänster och funktioner du planerar att erbjuda i Product Information Worksheet (PIW) och Integrator Validation Cover Sheet.
Steg 3: Skapa och skicka in nödvändiga filer till valideringsteamet
Samla ihop följande filer, komprimera dem till en .zip-fil och mejla till validationmtp@fedex.com. Vi rekommenderar att du skickar filerna i .zip-format för att reducera risken att ditt meddelande blockeras av e-postleverantören.
- Ifylld PIW för alla angivna områden/regioner (format: PDF)
- Ifylld Validation Cover Sheet (format: PDF)
- Skärmbilder på följande (format: PDF):
- Din kundupplevelse som visar FedEx tjänster/specialhantering
- Ansvarsfriskrivning
- Slutanvändaravtal
- Flöde för slutkundsregistrering
- Transkationer för slutkundsregistrering – flerfaktorsautentisering inklusive faktura och PIN-kod tillgänglig för sms, samtal och e-post (format: JSON-begäran/svarsfiler)
- Skannade kopior av faktiska utskrivna etiketter för alla testfall för de områden där du vill att din lösning ska valideras (format: PDF eller PNG)
- Frakttransaktioner för tre testfall, ett för varje etikettyp: PDF, PNG och ZPL (format: JSON-begäran/svarsfiler)
Följ denna bästa praxis för att undvika förseningar:
- Etiketterna måste skrivas ut och skannas med minst 600 DPI.
- Om du använder en termoskrivare måste etikettens bildtyp begäras i enlighet med skrivarmodellen. Exempel: ZPLII for Zebra-skrivare.
- FedEx International Express®-försändelser måste även ha en fraktsedelsetikett (AWB) i reserv.
- Flerkolliförsändelser måste ha en etikett för varje paket i försändelsen.
Steg 4: Granska etikettutvärderingen
Valideringsteamet kommer att utvärdera de inskickade filerna och godkänna eller avslå dem. Valideringsteamet kommer att kontakta dig avseende godkännandet eller avslåendet av filerna. Gå vidare till nästa steg om filerna godkänns. Om filerna avslås ska du korrigera transaktionerna, skärmarna och/eller etiketterna enligt anvisningarna och skicka in dem för godkännande igen.
Steg 5: Aktivera applikationen
När alla filer har godkänts för produktionsstatus kommer valideringsteamet att godkänna dina produktionsautentiseringsuppgifter för att överföra den identifierade försändelseetikettstransaktionen och meddela dig att certifieringen har godkänts via e-post. Godkännandet gäller endast för det specifika projektet.
Steg 6: Följ anvisningarna efter valideringen
Läs anvisningarna efter valideringen och följ dem efter behov.
