Aan de slag

Begin met uw integratie als FedEx Compatible-leverancier door te profiteren van de waarde die de FedEx-API's bieden. De instructies hieronder begeleiden u bij elke stap in het proces van het uitbreiden van functies van FedEx en mogelijkheden binnen uw oplossing.


Stap 1:

Blader door de API's om te bepalen wat u voor uw toepassing nodig hebt.

  • Ga naar de API-catalogus om te bepalen wat de juiste API's zijn voor uw toepassing.
  • Selecteer een API voor een overzicht, wijzigingslogboek en de belangrijkste eigenschappen van die API.
Screenshot van de pagina Tarievenoverzicht
  • Raadpleeg de documentatie van de API voor meer informatie over aanvraag- en responselementen, voorbeelden in de programmeertaal van uw keuze, foutcodes en meer.
Screenshot van de pagina Tariefdocumentatie
  • Controleer de Aankondigingen om te zien of er geplande service-updates zijn of ander nieuws is.

Stap 2:

Meld u aan om te beginnen met de integratie van FedEx-API's.

  • Meld u aan met uw gebruikers-ID en wachtwoord voor fedex.com om te beginnen met de integratie van FedEx-API's.
  • Indien u nog geen gebruikers-ID hebt, kunt u zich gratis aanmelden.

Stap 3:

Maak een organisatie aan of word lid van een organisatie.

Maak een organisatie aan als die voor uw bedrijf nog niet bestaat of word lid van de bestaande organisatie van uw bedrijf. U kunt een groot aantal gebruikers aan uw organisatie koppelen maar u kunt niet meerdere organisaties aan één gebruikers-ID koppelen.

Als u uw organisatie aanmaakt, wordt u automatisch vermeld als de beheerder van die organisatie. Een beheerder kan gebruikers uitnodigen om lid te worden van hun organisatie, hen toewijzen aan rollen en projecten en verzendaccounts beheren. Voor meer informatie over welke rollen het meest geschikt zijn voor verschillende personen, raadpleegt u onze Richtlijnen Organisatiebeheer. Om uw eigen organisatie aan te maken, klikt u op Mijn Projecten en vervolgens op de knop 'Organisatie aanmaken'. Deze knop wordt alleen weergegeven als u uw gebruikers-ID nog niet aan een andere organisatie hebt gekoppeld. Vanuit daar kunt u beginnen met het aanmaken van een organisatie door de volgende stappen uit te voeren (de stappen die zijn gemarkeerd met een * zijn optioneel):

  • Voer een naam in voor de organisatie.
  • Voer de e-mailadressen van de teamleden in die u wilt uitnodigen. Zij worden automatisch toegevoegd als een Kijker, die niet gekoppeld is aan projecten.*
screenshot van de pagina Uw organisatie maken

U kunt ook lid worden van de organisatie van uw bedrijf door de volgende stappen uit te voeren:

  • Indien uw bedrijf al een organisatie heeft aangemaakt, vraagt u de beheerder van die organisatie u hiervoor uit te nodigen. U heeft dan 24 uur de tijd om die uitnodiging te accepteren. Mocht het niet lukken om dit binnen die tijd te doen, dan kunt u hun vragen de uitnodiging opnieuw te versturen.
  • Om de uitnodiging te accepteren, dient u zich aan te melden met uw bestaande gebruikers-ID en wachtwoord of u maakt een nieuwe ID aan indien uw bestaande ID al aan een organisatie is gekoppeld.

Stap 4:

Voeg een verzendaccount toe.

Een beheerder kan zoveel verzendaccounts als nodig aanmaken voor de organisatie. Klik om te beginnen op de knop 'Account toevoegen' onder het tabblad Verzendaccounts op de pagina Organisatiebeheer. Vanuit daar kunt u bestaande verzendaccounts aan uw organisatie toevoegen door de volgende stappen uit te voeren:

  1. Vul de accountinformatie aan.
  • Voer uw accountnummer, een accountbijnaam en het factuuradres in dat aan uw account is gekoppeld. Om fraude te voorkomen, wordt dit gevalideerd om er zeker van te zijn dat het overeenkomt met de accountdetails.

  • Ga naar de pagina Verzendbeheerder om de verzendaccounts weer te geven die gekoppeld zijn aan uw gebruikers-ID. Om nieuwe verzendaccounts aan te maken, dient u contact op te nemen met uw FedEx Sales-vertegenwoordiger.

screenshot van de pagina Verzendaccount toevoegen
  1. Licentieovereenkomst voor eindgebruikers
screenshot van de pagina EULA uitvoeren

Stap 5:

Voeg gebruikers toe aan uw organisatie om samen te gaan werken met uw teamleden.

Een beheerder kan gebruikers uitnodigen om lid te worden van hun organisatie en hen aan rollen en projecten toewijzen. Klik om te beginnen op de knop 'Gebruikers toevoegen' onder het tabblad Gebruikers op de pagina Organisatie beheren. Vanuit daar kunt u beginnen met het toevoegen van gebruikers door de volgende stappen uit te voeren (de stappen die zijn gemarkeerd met een * zijn optioneel):

  1. Voer de e-mailadressen in van de gebruiker(s) die aan uw organisatie moet(en) worden toegevoegd. Voer meerdere e-mailadressen in door op uw toetsenbord op spatie, komma, puntkomma of Enter te drukken.
  2. Kies een rol als de standaardoptie Kijker niet geschikt is voor de gebruiker.*
  3. Kies een project dat aan uw organisatie is gekoppeld zodat u daar gebruikers aan kunt toevoegen. Indien u nog geen project hebt aangemaakt, wordt dit in de volgende stap toegelicht.*
screenshot van de pagina Gebruikers toevoegen

Een beheerder heeft altijd toegang tot alle projecten maar een bijdrager of kijker moet aan een project zijn toegewezen, tenzij de bijdrager het project heeft aangemaakt. Ongeacht of een gebruiker de uitnodiging wel of niet heeft geaccepteerd, kunt u hun projecten of rollen meteen vanuit de tab Gebruikers op het scherm Organisatiebeheer bijwerken. U hoeft alleen op het caret naast de rol of het project te klikken en er verschijnt een keuzelijst met opties waaruit u kunt kiezen. Maak uw keuze en selecteer vervolgens de knop "Toepassen" om uw selectie op te slaan.

screenshot van de pagina Organisatie beheren

Stap 6:

Maak een project aan om gegevens te verkrijgen.

Op de pagina Mijn Projecten kan een beheerder of bijdrager een project aanmaken door de knop 'Project aanmaken' te selecteren. Vanuit daar kunnen zij beginnen met het aanmaken van een project door de volgende stappen uit te voeren (de stappen die zijn gemarkeerd met een * zijn optioneel):

1.  Stel een project in        

  • Geef uw project een naam die u makkelijk kunt herkennen en die uniek is voor uw organisatie.
  • Begin door minimaal één API te selecteren die u aan uw project wilt toevoegen. U kunt later altijd nog API's toevoegen of verwijderen.           
screenshot van stap 1 voor het aanmaken van een project 

2. Accepteer voorwaarden

screenshot van stap 2 voor het aanmaken van een project
       
         3.  Configureer uw project
 
  • Selecteer landen waarbinnen u wilt verzenden, zodat wij een testverzendaccount aan u kunnen toewijzen. Om de binnenlandse verzending van pakketten in een Europees land te testen, dient u per land een afzonderlijk testaccount aan te maken. U kunt later altijd nog landen toevoegen/verwijderen.*
  • Als u van plan bent om FedEx SmartPost® Retouren of FedEx Freight® LTL te gaan gebruiken, selecteer dan Ja.*
  • Zodra u op de knop 'Aanmaken' klikt, ziet u een bevestigingsscherm. Binnen uw nieuwe project kunt u nu uw testgegevens bekijken. 
screenshot van stap 3 voor het aanmaken van een project

Stap 7:

Integreer API's in uw toepassing en test uw implementatie.

  1. Haal testgegevens (API-sleutel, geheime sleutel en verzendaccount(s)) op via het tabblad Testsleutel van de pagina Projectoverzicht.
screenshot van de pagina Testsleutels
  1. Vraag een OAuth-toegangstoken aan dat bij elke API-transactie gebruikt moet worden. De sessie voor het token is slechts één uur geldig. Het is dus noodzakelijk dat u uw toepassing programmeert om het token te vernieuwen voordat de sessie verloopt. Raadpleeg de documentatie van de API-authorisatie voor meer informatie.
  2. Selecteer documenten voor de API's op uw Test Keys-pagina en lees de zakelijke context door om een goed begrip te krijgen van hoe u de geselecteerde API dient te gebruiken. Bekijk voorbeeldaanvragen voor het eindpunt die passen bij de gewenste integratie.
  3. Implementeer uw oproepen aan deze eindpunten zoals beschreven in de voorbeeldaanvragen en configureer ze voor het gebruik van uw testgegevens.
  4. Verifieer of de ontvangen API-oproepreacties overeenkomen met die in de documentatie.
  5. Test uw implementatie volledig binnen de testomgeving van FedEx met testreferenties en de FedEx-test-URI's.

Stap 8:

Verplaats uw project naar productie.

Op de pagina Projectoverzicht klikt u op het tabblad Productiesleutel. Vanuit daar kunt u beginnen met het verplaatsen van uw project naar productie door de volgende stappen uit te voeren (de stappen die zijn gemarkeerd met een * zijn optioneel):

  1. Project configureren.
  • Wijzig de naam van uw productie-API-sleutel.*
  • Er moet op dit moment minimaal één verzendaccount worden toegevoegd maar u kunt meer accounts toevoegen nadat uw project met succes naar productie is verplaatst. Indien u geen verzendaccounts hebt die aan uw organisatie zijn gekoppeld of als de EULA voor verzendaccounts die aan uw organisatie zijn toegevoegd niet is ondertekend, verschijnen ze niet in de keuzelijst.
screenshot van stap 1 van de pagina Productiesleutels
  1. Projectsleutels ophalen.
  • Vervolgens wordt uw productie-API-sleutel en uw productie-geheime-sleutel weergegeven. Zorg ervoor dat u deze op een veilige plek bewaart.
  • Om uw productie-geheime-sleutel veilig te houden, laten we deze slechts één keer zien. Als u uw geheime sleutel kwijtraakt, kunt u een nieuwe genereren.
screenshot van stap 2 van de pagina  Productiesleutels

Stap 9:

Voltooi uw integratie.

  1. Voor sommige API's is basis- of verzendlabelcertificering vereist voor gebruik in onze productieomgeving. Voltooi het certificeringsproces voor de API's in uw project die deze vereiste hebben.
screenshot van de pagina Certificering
  1. Nadat alle API's zijn gecertificeerd en ingeschakeld, werkt u uw API-verzoeken bij door de test-URI's, sleutels en verzendaccounts te vervangen door de productie-URI's, sleutels en verzendaccounts
  2. Test uw implementatie in de productieomgeving opnieuw met gebruik van voorbeeldgegevens.
  3. Veel succes met uw nieuwe integratie!


Stap 1: 

FedEx zet een organisatie op voor Compatible-leveranciers.

  • FedEx zet een organisatie op en nodigt dan één teamlid uit om lid te worden van de organisatie. Deze gebruiker wordt aangewezen als de 'Beheerder' van uw organisatie.
  • Als de certificering en integratie voltooid zijn, kunt u de oplossing probleemloos aan uw klanten distribueren.

Stap 2:

Uitnodiging accepteren.

  • Accepteer de uitnodiging om toegang te krijgen tot de API-integratie en -documentatie. Om de uitnodiging te accepteren, dient u zich aan te melden met uw FedEx gebruikers-ID en wachtwoord of u maakt een nieuwe ID aan als u nog geen inloggegevens hebt.
screenshot van de pagina Meld u aan om te beginnen met de integratie van FedEx-API's

Stap 3:

Nodig gebruikers uit voor uw organisatie.

  • Als Beheerder kunt u alle teamleden uitnodigen die toegang moeten hebben tot het project of de organisatie. Voor meer informatie over de verschillende rollen, raadpleegt u de Richtlijnen Organisatiebeheer.
screenshot van de pagina Organisatiegebruikers beheren
  • Indien uw organisatie al is aangemaakt, vraagt u de beheerder van die organisatie u hiervoor uit te nodigen. U hebt dan 24 uur de tijd om die uitnodiging te accepteren. Mocht het niet lukken om dit binnen die tijd te doen, dan kunt u ze vragen de uitnodiging opnieuw te versturen.

Stap 4:

Kies de API's die u voor uw oplossing nodig hebt.

  • Ga naar de API-catalogus om te bepalen wat de juiste API's zijn voor uw oplossing. Uw FedEx-adviseurs op het gebied van klantentechnologie (CTC) en Compatible Channel-manager kunnen u helpen de juiste API's voor uw oplossing te kiezen, afhankelijk van uw zakelijke behoeften.

screenshot van de pagina API-catalogus
  • Selecteer een API voor een overzicht, wijzigingslogboeken en de belangrijkste eigenschappen van die API.

screenshot van de pagina Overzicht van adresvalidatie-API
  • Raadpleeg de documentatie van de API voor meer informatie over aanvraag- en responselementen, voorbeelden in de taal van uw keuze, foutobjecten en meer.

screenshot van de pagina Documentatie van adresvalidatie-API
  • Ga terug naar Salesforce om het Product Information Worksheet (PIW) in te vullen en een lijst te maken van de API's die u aan uw oplossing wilt laten toevoegen.


Stap 5:

FedEx zet project(en) op.

Zodra de PIW is goedgekeurd, zal FedEx uw project(en) opzetten. Voor elke versie van elke oplossing wordt een apart project opgezet in het FedEx Developer Portal. Als een gebruiker geen Beheerder van de organisatie is, moet hij/zij uitgenodigd worden om elk project te bekijken. 

Op dit moment zal het FedEx Compatible-team samen met de FedEx CTC- en certificeringsteams een technische demonstratie van de API's voor uw team organiseren. Het FedEx-team zal de nieuwe eigenschappen en functionaliteiten bespreken die beschikbaar zijn voor de versie van de API's die u gebruikt. Het team kan technische vragen beantwoorden over API's, API-tests en alle processen die moeten worden doorlopen om een begin te maken met het proces van 'certificering*' van API's.

*Certificering: het door het FedEx Compatible-programma gedefinieerde proces om aan de eisen van het programma te voldoen. Certificering voor Compatibele-programma's is nodig om ervoor te zorgen dat alle Compatibele-aanbieders FedEx-technologie implementeren, op de markt brengen en distribueren naar verzenders (klanten) zoals gedefinieerd door de technologie- en servicenormen van FedEx.


Stap 6:

Integreer API's in uw toepassing en certificeer uzelf volgens het Compatible-programma.

  1. U hebt nu toegang tot uw API-sleutel en geheime testsleutel, zodat u transacties uit kunt voeren. Haal ze op van het tabblad Testsleutel op de pagina Projectoverzicht.
screenshot van het tabblad Testsleutel op de pagina Projectoverzicht
  1. Om klantsleutels aan te maken, moet u de Gegevensregistratie-API gebruiken, wat een privé-API is die alleen te vinden is in de API-sectie van elk van uw projecten.
  2. Zodra u een aantal klantsleutels hebt aangemaakt, gaat u verder en vraagt u een OAuth-toegangstoken aan om te gebruiken bij elke API-transactie. De sessie voor het token is slechts één uur geldig. Het is dus noodzakelijk dat u uw toepassing programmeert om het token te vernieuwen voordat de sessie verloopt. Raadpleeg de documentatie van de API-authorisatie voor meer informatie. Zorg er bij het bekijken van de voorbeeldcode voor dat u 'Reseller' kiest in de keuzelijst met voorbeelden.
screenshot van de keuzelijst voor de voorbeeldcode 'samples' voor de pagina Gegevensregistratie-API
  1. Selecteer documenten voor de API's op uw Test Keys-pagina en lees de zakelijke context door om een goed begrip te krijgen van hoe u de geselecteerde API dient te gebruiken. Bekijk voorbeeldaanvragen voor het eindpunt die passen bij de gewenste integratie.
  2. Implementeer uw oproepen aan deze eindpunten zoals beschreven in de voorbeeldaanvragen en configureer ze voor het gebruik van uw testgegevens.
  3. Verifieer of de ontvangen API-oproepreacties overeenkomen met die in de documentatie.
  4. Test uw implementatie volledig binnen de testomgeving van FedEx met testreferenties en de FedEx-test-URI's.
  5. Nadat u uw oplossingen volledig getest hebt, certificeert u elke oplossing in Salesforce. FedEx bekijkt alles wat wordt ingediend en houdt u op de hoogte zodra uw certificering is goedgekeurd.

Stap 7:

FedEx brengt project(en) naar productie.

  • FedEx zal dan uw project(en) naar productie brengen.
  • U zult dan uw geheime sleutel voor productie zien op het tabblad Productie op de pagina Projectoverzicht.
screenshot van Compatibele versie met Link genereren weergegeven voor het tabblad Productie op de pagina Projectoverzicht

Stap 8:

Geheime sleutel voor productie genereren.

  • Uw geheime sleutel voor productie moet gegenereerd worden door op de link Geheim genereren te klikken onder de kolom Geheime sleutel.
  • U kunt nu uw implementatie opnieuw testen in de productieomgeving met behulp van voorbeeldgegevens.
  • Veel succes met uw nieuwe integratie!