1. Skapa ett projekt för att få autentiseringsuppgifter
2. Integrera API:er och testa implementeringen
3. Flytta projektet till produktionsmiljön
4. Slutför din certifiering

En administratör eller deltagare för din organisation kan skapa ett API-projekt genom att klicka på knappen Skapa ett API-projekt.

Innan du kan komma i gång vill vi veta varför du behöver tillgång till FedEx API:er. Ett fönster med alternativ i en listruta kommer att visas. Välj det alternativ som bäst identifierar dina verksamhetsbehov för integrering med FedEx API:er.

Om du identifierar dig som avsändare kan du börja skapa ditt projekt. Processen består av tre steg:

Välj API:er

Välj det eller de API:er som du vill inkludera i projektet. Du kan behöva göra några ytterligare val, beroende på vilket eller vilka API:er som du väljer.

Om du väljer API:et Spårning måste du även göra följande:

• Välj ett kontonummer att koppla till din produktionsnyckel.
• Granska kvoterna, anropsbegränsningarna och API-certifieringsuppgifterna för API:et Spårning.
• Välj om du vill registrera dig för e-postmeddelanden som informerar om du skulle överskrida din transaktionskvot.

Konfigurera projekt

Ange projektuppgifter, inklusive namn och leveransadress.

• 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.

Bekräfta uppgifter

Granska projektuppgifterna och godkänn därefter villkoren.

• Läs och godkänn licensavtalet för FedEx Developer Portal och bekräfta att du inte tänker sälja eller distribuera ditt program.
• Ett bekräftelsefönster visas efter att du har klickat på knappen ”Skapa”. Du kan därefter visa dina autentiseringsuppgifter för tester i det nya projektet.

• Begära en OAuth-åtkomsttoken som måste användas med varje API-transaktion. Token är endast giltig i en timme, så du måste programmera programmet att uppdatera token innan den upphör att gälla. Mer information finns i dokumentationen om auktorisering av API:er.
• Klicka på valfri API-dokumentation för att läsa affärskontexten för varje API, så att du kan få en uppfattning om hur det ska användas. Granska exempelbegärandena för slutpunkten som matchar den önskade integreringen.
• Implementera dina anrop till slutpunkterna enligt beskrivningen i exempelbegärandena och konfigurera dem med dina autentiseringsuppgifter för testmiljön.
• Verifiera att svaren på API-anropen stämmer överens med de som visas i dokumentationen.
• Testa din implementering i FedEx testmiljö med autentiseringsuppgifterna och FedEx test-URL:er.

I steget Konfigurera projekt:

• Du kan byta 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.

I steget Hämta projektnycklar:

• Din API-nyckel och hemliga nyckel för produktionsmiljön visas. Spara nycklarna 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.
• Klicka på Nästa.

Du kommer nu att skickas tillbaka till sidan Projektöversikt. Där kan du lägga till fler konton som är kopplade till projektet.

På sidan Projektöversikt:

• Klicka på de tre vertikala prickarna för att lägga till fler konton som är kopplade till projektet.
• Klicka därefter på Redigera.

Du kommer att skickas vidare till sidan API-nyckel, där du kan lägga till eventuella ytterligare konton som du vill koppla till din produktionsnyckel för det här projektet.

1. Vissa API:er kräver certifiering av försändelseetikett om de ska användas i vår produktionsmiljö. Slutför certifieringsprocessen för alla API:er i projektet med det här kravet.

1. Efter att alla API:er har certifierats och aktiverats ska du uppdatera API-begärandena genom att byta ut URI:erna, nycklarna och försändelsekontona för testmiljön mot URI:erna, nycklarna och försändelsekontot för produktionsmiljön.

2. Testa implementeringen igen i produktionsmiljön med hjälp av exempeldata.

3. Nu kan du använda din nya integration!

Förutsättningar för att skapa ett webbhookprojekt

1. Skapa en giltig URL i ditt destinationsprogram/på din destinationsplattform
2. Skapa säkerhetstoken
3. Testa webbhook-URL:er
4. Validera destinations-URL

Skapa ett webbhookprojekt

1. Skapa ett webbhookprojekt för att få konfigurerade belastningsaviseringar

Förutsättningar för att skapa ett webbhookprojekt

Skapa en giltig URL i ditt destinationsprogram/på din destinationsplattform för att ta emot autentiseringskoder/-meddelanden och belastningsmeddeladen för spårningswebhookar från FedEx.

URL-krav:

Den här säkerhetstoken kan användas som en hemlig nyckel för att autentisera och validera information som överförs mellan dig (kunden) och FedEx.

Krav för säkerhetstoken:

• Minst 25 tecken och högst 100 tecken
• En stor bokstav
• En liten bokstav
• Ett numeriskt tecken

Att testa din URL är ett valfritt steg som kan vara till hjälp.

Tester kan bidra till att få en bättre uppfattning om huruvida URL:en som du skapade i steg 1 är giltig. Det gör det möjligt för FedEx att identifiera din URL och upprätta en anslutning till din URL 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 ditt program. Testerna autentiserar däremot inte din URL.

Läs mer om hur du testar din webbhook-URL i vår webbhookdokumentation.

Använd HMAC SHA256-algoritmmetoden för att konfigurera en autentiseringsprocess för att validera informationen som överförs mellan din destinations-URL och FedEx.

1. När du klickar på Skapa genererar FedEx en slumpmässig challenge-sträng, som skickas till dig i begärandet. Du förväntas därefter skicka tillbaka challenge-strängen till FedEx i svaret.

1. Initiera en meddelandeautentiseringskod (MAC) med hjälp av HMAC SHA256-algoritmen/-proceduren för att hasha (eller kombinera) challenge-strängen och säkerhetstoken (eller den hemliga nyckeln) för att skapa en hash-signatur

1. Svara FedEx med challengeString och challengeStringResponse i svaret, tillsammans med HTTP-statuskoden 200 (OK) eller 202 (ACCEPTED).

1. FedEx kommer nu att validera säkerhetssträngen och svaret i säkerhetssträngen.

• När FedEx har tagit emot svaret kommer FedEx att validera challengeString och challengeStringResponse (eller HMAC-signaturen som genererades tidigare) genom att jämföra dem med challengeString respektive HMAC-signaturen som genererades av FedEx.

• Om både challengeString och HMAC-signaturen stämmer överens har valideringen och arbetsflödet lyckats. Om de inte stämmer överens misslyckas valideringsprocessen och ett motsvarande felmeddelande kommer att visas.

Skapa ett webbhookprojekt

Gå till fliken Webbhookar på sidan Mina projekt.

En administratör eller deltagare för din organisation kan skapa ett webbhookprojekt genom att klicka på knappen Skapa en webbhook.

Innan du kan komma i gång vill vi veta varför du behöver tillgång till FedEx webbhookar. Ett fönster med alternativ i en listruta kommer att visas. Välj det alternativ som bäst identifierar varför din verksamhet vill integrera med FedEx webbhookar.

Om du identifierar dig som avsändare kan du börja skapa ditt projekt genom att göra följande:

1. Identifiera verksamhetens behov

• Välj det alternativ som bäst identifierar varför din verksamhet vill integrera med FedEx webbhookar.

1. Välj nivå och nivåfunktioner

• Välj antingen en grundläggande eller en avancerad webbhooknivå för projektet, baserat på dina behov.
• Du kan alltid ändra valet av nivå vid ett senare tillfälle.
• Varje nivå har en månadsavgift.

• Välj de funktion som du vill ska konfigureras med projektet.
• Du kan även redigera funktionerna vid ett senare tillfälle.

1. Konfigurera projektuppgifter

• Ge projektet ett identifierbart namn
• Tillhandahåll förgenererade uppgifter för destinations-URL:er och säkerhetstoken, vilka skapas under autentiseringen före konfigurationen.

Välj konton

• Välj från en lista med berättigade (USA- eller Kanada-baserade) kontonummer som du vill ska vara kopplade till projektet.

  5. Bekräfta uppgifter och godkänna villkor

• Granska uppgifterna för ditt konfigurerade projekt.
• Läs och godkänn licensavtalet för FedEx Developer Portal och bekräfta att du inte tänker distribuera ditt program.
• Läs och godkänn prisavtalet.
• När du klickar på knappen Skapa projekt:

1. Om din skapandebegäran har validerats och behandlats kommer du att skickas vidare till en bekräftelsesida.

• Om valideringen misslyckades visas istället ett felmeddelande.

1. Ditt spårningswebbhookprojekt kommer att ha ett systemgenererat webbhook-ID och statusen ”Aktiv”.

1. FedEx skapar en organisation för Compatible-leverantören.
2. Acceptera inbjudan.
3. Bjud in användare till din organisation.
4. Välj de API:er som du behöver för din lösning.
5. FedEx skapar projekt.
6. Integrera API:er i din applikation och certifiera dig för Compatible-programmet.
7. FedEx flyttar projekt till produktion.
8. Skapa hemlig produktionsnyckel.

• 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.
• När certifiering och integrering har slutförts kan du enkelt distribuera lösningen till dina kunder.

• Acceptera inbjudan för att få tillgång till API-integrering och -dokumentation. För att kunna acceptera inbjudan måste du antingen logga in med ditt FedEx-användar-ID och lösenord eller skapa ett nytt konto om du inte har några autentiseringsuppgifter.

• Som administratör kan du bjuda in alla teammedlemmar som behöver tillgång till ett projekt eller organisationen. Mer information om de olika rollerna finns i guiden för organisationsadministration.

• Om din organisation redan har skapats kan du be organisationens administratör att bjuda in dig. Du har 24 timmar på dig att acceptera inbjudan, men om du missar att göra det kan du be administratören att skicka inbjudan igen.

• Gå till API-katalog för att välja lämpliga API:er 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.

• Välj ett API för att visa dess översikt, ändringsloggar och nyckelfunktioner.

• Läs API:ets dokumentation för mer information om begäranden och svar, exempel på ditt valda språk, felkoder och mycket mer.

• Gå tillbaka till Salesforce för att fylla i Product Information Worksheet (PIW) och lista de API:er som du vill ska läggas till för din lösning.

När PIW har godkänts kommer FedEx att skapa dina projekt. Varje version av dina lösningar kommer att ha ett separat projekt i FedEx Developer Portal. Användare som inte är administratörer för organisationen måste bjudas in för att kunna visa varje projekt. 

Det är även nu som FedEx Compatible-teamet tillsammans med FedEx CTC- och certifieringsteamen håller en teknisk demonstration om API:erna för ditt team. FedEx-teamet kommer att diskutera de nya funktionerna i den version av API:er som ni ska börja använda. Teamet kommer att gå igenom tekniska frågor om API:er, API-tester och alla processer som måste slutföras för att inleda certifieringsprocessen för API:er.

* Certifiering – processen som i FedEx Compatible-programmet definieras som att uppfylla krav på programefterlevnad. Compatible-programcertifiering krävs för att säkerställa att alla Compatible-leverantörer implementerar, marknadsför och distribuerar FedEx-teknik till avsändare (kunder) i enlighet med standarder för FedEx-teknik och -tjänster.

1. Du kommer nu att ha tillgång till din API-testnyckel och hemliga testnyckel och kan börja köra transaktioner. Du kan hämta dem på fliken Testnyckel på sidan Projektöversikt.

1. För att skapa kundnycklar måste du använda API:et Registrering av autentiseringsuppgifter, vilket är ett privat API som endast finns i API-delen av varje projekt.
2. När du har skapat några kundnycklar kan du begära en OAuth-åtkomsttoken som ska användas med varje API-transaktion. Token är endast giltig i en timme, så du måste programmera programmet att uppdatera token innan den löper ut. 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.

1. Välj dokumentationen för API:erna på sidan Testnycklar och läs affärskontexten för att få en uppfattning om hur det valda API:et ska användas. Granska exempelbegärandena för slutpunkten som matchar den önskade integreringen.
2. Implementera dina anrop till slutpunkterna enligt beskrivningen i exempelbegärandena och konfigurera dem för att använda dina autentiseringsuppgifter för testmiljön.
3. Verifiera att de mottagna svaren på API-anropen matchar de som visas i dokumentationen.
4. Testa din implementering helt i FedEx testmiljö med autentiseringsuppgifterna och FedEx test-URI:er.
5. Certifiera alla lösningar i Salesforce efter att du har testat dem. FedEx kommer att granska allt som du skickar in och uppdatera när din certifiering är godkänd.

• FedEx kommer därefter att flytta dina projekt till produktion.
• Du kan därefter visa din API-produktionsnyckel på fliken Produktionsnyckel på sidan Projektöversikt.

• Skapa din hemliga produktionsnyckel genom att klicka på länken Skapa en hemlig nyckel i kolumnen Hemlig nyckel.
• Nu kan du testa implementeringen igen i produktionsmiljön med hjälp av exempeldata.
• Nu kan du använda din nya integration!