Aan de slag
Zodra u met FedEx integreert, kunt u profiteren van de voordelen die FedEx-API's en -webhooks bieden. Deze instructies leiden u door het proces van het opzetten van een organisatie, het aanmaken van projecten of het aan de slag gaan als compatibele gebruiker.
Stap 1:
Door API's en webhooks bladeren
U kunt beginnen met het bekijken van onze API's en webhooks om uw behoeften te bepalen en de beste oplossingen voor uw applicatie te vinden.
- Ga naar de API-catalogus om te beginnen met bladeren.
- Selecteer een API of webhook om een samenvatting te lezen, het wijzigingslogboek te verkennen en de belangrijkste functies te bekijken..
- Bekijk de documentatie voor meer informatie over aanvraag- en responselementen, voorbeelden in de programmeertaal van uw keuze, foutcodes en meer.
- Ga naar de pagina Aankondigingen om te zien of er geplande service-updates zijn of ander nieuws is.
Stap 2:
Aanmelden
Meld u aan met uw gebruikersnaam en wachtwoord voor fedex.com om te beginnen met de integratie van FedEx-API's en -webhooks.
Als u nog geen gebruikersnaam 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.
Een organisatie aanmaken:
Als u een organisatie aanmaakt, wordt u automatisch vermeld als de beheerder van die organisatie.
- Een beheerder kan gebruikers uitnodigen om lid te worden van zijn organisatie, hen rollen toewijzen (bijv. bijdrager of kijker) en projecten, en kan verzendaccounts beheren.
- Voor meer informatie over deze rollen raadpleegt u onze Richtlijnen organisatiebeheer.
Om uw eigen organisatie aan te maken, klikt u op Organisatie aanmaken in de navigatie aan de linkerkant.
Organisatiegegevens verstrekken
- Verstrek uw bedrijfsnaam, website-URL en een organisatienaam. Geef uw organisatie een naam die andere gebruikers zullen herkennen. Deze naam kan worden gebruikt om uw bedrijf op te splitsen in specifieke groepen (bijv. afdeling, divisie, regio, locatie), maar het kan ook dezelfde naam als uw bedrijfsnaam zijn.
Lid worden van een organisatie:
U kunt lid worden van een reeds bestaande organisatie door de volgende stappen uit te voeren:
- Vraag de beheerder van uw organisatie om u een uitnodiging te sturen
- Als uw bedrijf al een organisatie heeft aangemaakt, vraagt u de beheerder van de organisatie u uit te nodigen om lid te worden. U hebt 24 uur de tijd om deze uitnodiging te accepteren. Als u dit tijdvenster mist, kunt u altijd vragen de uitnodiging opnieuw te versturen.
- De uitnodiging accepteren
- Om de uitnodiging te accepteren, moet u zich aanmelden met uw bestaande gebruikersnaam en wachtwoord of, als uw bestaande gebruikersnaam al is gekoppeld aan een organisatie, moet u een nieuwe aanmaken.
Stap 4:
Voeg een verzendaccount toe.
- Vul de accountinformatie aan.
- Voer uw accountnummer, een accountbijnaam en het factuuradres in dat aan uw account is gekoppeld. Wij zullen dan het factuuradres valideren om er zeker van te zijn dat het overeenkomt met de accountgegevens om frauduleuze activiteiten te voorkomen.
- Om de verzendaccounts weer te geven die aan uw gebruikersnaam zijn gekoppeld, gaat u naar de pagina Organisatie beheren en het tabblad Verzendaccounts. Om nieuwe verzendaccounts aan te maken, dient u contact op te nemen met uw FedEx-accountmanager.
- Licentieovereenkomst voor eindgebruikers
- U moet vervolgens de Licentieovereenkomst voor eindgebruikers (EULA) accepteren of deze naar een andere persoon binnen het eindgebruikersbedrijf sturen die de overeenkomst kan accepteren. U kunt de status van de EULA bekijken op de pagina Organisatie beheren, onder het tabblad Verzendaccount.
Stap 5:
Gebruikers aan uw organisatie toevoegen
Een beheerder kan gebruikers uitnodigen om lid te worden van hun organisatie en hen aan rollen en projecten toewijzen. Om te beginnen, kunt u gebruikers toevoegen op de pagina Organisatie beheren door de volgende stappen uit te voeren (de stappen met een * zijn optioneel):
E-mailadressen van gebruikers invoeren
- Voer de e-mailadressen van gebruikers in die u wilt uitnodigen om lid te worden van uw organisatie. U kunt meerdere e-mailadressen invoeren door met uw toetsenbord een spatie, komma, puntkomma of enter tussen de adressen te plaatsen.
Gebruikersrollen selecteren
- Kies een andere gebruikersrol als de standaardoptie van Kijker niet overeenkomt met de behoeften van de betreffende gebruiker.*
Gebruikers aan een project toewijzen
- Als u al projecten hebt aangemaakt, kunt u gebruikers aan een project toewijzen.*
Een beheerder heeft altijd toegang tot alle projecten, maar een bijdrager of kijker moet aan een project worden toegewezen (tenzij een bijdrager een project aanmaakt, in welk geval hij of zij automatisch aan dat project wordt toegewezen).
Of een gebruiker de uitnodiging nu wel of niet heeft geaccepteerd, u kunt zijn of haar projecten of rollen snel bijwerken vanaf de pagina Organisatie beheren, onder het tabblad Gebruikers.
- Klik op de caret naast de rol of het project, waarna een keuzelijst met opties verschijnt.
- Selecteer een optie en selecteer vervolgens de knop Toepassen om uw selectie op te slaan.
Stap 1:
Maak een project aan om gegevens te verkrijgen.
Een beheerder of bijdrager van uw organisatie kan een API-project aanmaken door op de knop Een API-project aanmaken te klikken.
Voordat u aan de slag gaat, moet u ons eerst laten weten waarom u toegang wilt krijgen tot FedEx-API's. Er verschijnt een dialoogvenster met keuzelijstopties. U moet de optie selecteren die het beste aansluit bij uw bedrijfsbehoeften voor integratie met FedEx-API's.
Als u zich identificeert als afzender, kunt u beginnen met het aanmaken van uw project. Dit proces bestaat uit drie stappen:
- API's selecteren
Selecteer de API('s) die u wilt opnemen in uw project. Afhankelijk van de API('s) die u selecteert, moet u mogelijk enkele aanvullende selecties maken.
Als u de traceer-API selecteert, moet u ook:
- Een accountnummer selecteren dat u aan uw productiesleutel wilt koppelen.
- De API-quota, tariefbeperkingen en API-certificeringsgegevens controleren.
- Kiezen of u wel of niet e-mails wilt ontvangen die u waarschuwen als u uw transactiequota overschrijdt.
- Project configureren
Voer enkele projectspecificaties in, zoals de naam en verzendlocatie.
- Geef uw project een naam die u makkelijk kunt herkennen en die uniek is voor uw organisatie.
- Selecteer de landen waarbinnen u wilt verzenden, zodat wij u een testverzendaccount kunnen toewijzen. Om de binnenlandse verzending van pakketten in een Europees land te testen, dient u per land over een afzonderlijk testaccount te beschikken. U kunt altijd later landen toevoegen/verwijderen.
- Om op de hoogte te worden gesteld van de nieuwste API-updates en informatie over storingen, kunt u uw meldingsvoorkeuren instellen.
- Gegevens bevestigen
Bekijk uw projectgegevens en accepteer vervolgens de Algemene voorwaarden.
- Lees en accepteer de Licentieovereenkomst voor de FedEx Developer Portal en bevestig dat u niet de intentie hebt om uw applicatie te verkopen of distribueren.
- Zodra u op de knop 'Aanmaken' klikt, ziet u een bevestigingsscherm. U kunt dan uw testreferenties in uw nieuwe project bekijken.
Stap 2:
Integreer API's en test uw implementatie
– op van het tabblad Testsleutel. Hierna kunt u:
- Een OAuth-toegangstoken aanvragen dat bij elke API-transactie moet worden gebruikt. Het token is slechts één uur geldig. Het is dus noodzakelijk dat u uw applicatie programmeert om het token te vernieuwen voordat de sessie verloopt. Raadpleeg de documentatie van de API-autorisatie voor meer informatie.
- Klik op de documenten voor uw API's om de zakelijke context voor elke API te lezen, zodat u het beste begrijpt hoe u deze kunt gebruiken. U kunt ook voorbeeldaanvragen bekijken voor het eindpunt dat overeenkomt met uw gewenste integratie.
- Implementeer uw aanroepen voor deze eindpunten zoals beschreven in de voorbeeldaanvragen en configureer ze met uw testreferenties.
- Controleer of de reacties op de API-aanroepen die u ontvangt, overeenkomen met de reacties die in de documentatie staan vermeld.
- Test uw implementatie in de FedEx-testomgeving met uw testreferenties en de test-URL's van FedEx.
Stap 3:
Verplaats uw project naar productie
de volgende stappen uit te voeren.
In de stap Project configureren:
- Kunt u uw sleutel, indien nodig, een andere naam geven.
- Controleert u het accountnummer dat u in stap 1 van de projectaanmaakstroom hebt geselecteerd. Dit wordt gebruikt om uw project naar productie te verplaatsen. Zodra uw project live is in productie, kunt u, indien nodig, meer accounts toevoegen.
In de stap Projectsleutels ophalen:
- Worden uw API-productiesleutel en uw geheime productiesleutel weergegeven. Zorg ervoor dat u deze op een veilige plek bewaart.
- Om uw geheime productiesleutel veilig te houden, laten we deze slechts één keer zien. Als u uw geheime sleutel kwijtraakt, kunt u een nieuwe genereren.
- Klik op Volgende.
U wordt nu teruggebracht naar de pagina Projectoverzicht. Hier kunt u meer accounts toevoegen die aan uw project zijn gekoppeld.
Op de pagina Projectoverzicht:
- Klik op de 3 verticale stippen (of hamburgermenu) om meer accounts aan uw project toe te voegen.
- Klik vervolgens op Bewerken.
Dit brengt u naar de pagina API-sleutel, waar u eventuele extra accounts kunt toevoegen die u aan uw productiesleutel voor dit project wilt koppelen.
Stap 4:
Voltooi uw certificering
- Sommige API's vereisen verzendetiketcertificering voor gebruik in onze productieomgeving. Voltooi het certificeringsproces voor de API's in uw projecten die deze vereiste hebben.
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.
Test uw implementatie in de productieomgeving opnieuw met gebruik van voorbeeldgegevens.
Veel succes met uw nieuwe integratie!
Vereisten voor het aanmaken van een webhookproject
- Een geldige URL aanmaken in uw bestemmingsapplicatie/-platform
- Beveiligingstoken genereren
- Webhook-URL testen
- Bestemmings-URL verifiëren
Webhookproject aanmaken
Vereisten voor het aanmaken van een webhookproject
Stap 1:
Een geldige URL aanmaken in uw bestemmingsapplicatie/-platform
Maak een geldige URL aan in uw bestemmingsapplicatie/-platform om verificatiecodes/-berichten en tracking-webhookmeldingen over het laadvermogen van FedEx te ontvangen.
URL-vereisten:
- Bevat RFC1918 IP-ruimte
- Bevat fedex.com of een van de bijbehorende subdomeinen
- Bevat IP-adressen in de URL (inclusief localhost, 127.0.0.1)
Stap 2:
Beveiligingstoken genereren
Dit beveiligingstoken kan worden gebruikt als een geheime sleutel voor het verifiëren en valideren van informatie die tussen u (de klant) en FedEx wordt verzonden.
Vereisten voor het beveiligingstoken:
- een minimale lengte van 25 tekens en een maximale lengte van 100 tekens
- 1 hoofdletter
- 1 kleine letter
- 1 cijfer
Stap 3:
Webhook-URL testen
Het testen van uw URL is een optionele stap die mogelijk nuttig voor u is.
Testen kan u helpen om een beter idee te krijgen of de URL die u in stap 1 hebt aangemaakt, geldig is. Hiermee kan FedEx uw URL identificeren en een verbinding met uw URL opzetten om gegevens te verzenden. Testen kan u ook voorzien van testgegevens waarmee u kunt controleren en bevestigen of de trackinggegevens in uw applicatie worden verwerkt. Testen verifieert echter niet uw URL.
Raadpleeg onze webhookdocumentatie voor meer informatie over hoe u uw webhook-URL kunt testen.
Stap 4:
Bestemmings-URL verifiëren
Met behulp van de hashing-algoritmemethode HMAC SHA256 kunt u een verificatieproces opzetten om de informatie te valideren die tussen uw bestemmings-URL en FedEx wordt verzonden.
- Wanneer u op Aanmaken klikt, genereert FedEx een willekeurige uitdagingstekenreeks, die naar u wordt verzonden in de aanvraagtekst. Van u wordt op uw beurt verwacht dat u deze uitdagingstekenreeks in de responstekst terugstuurt naar FedEx.
- Initialiseer de berichtauthenticatiecode (MAC) met behulp van het algoritme/de procedure HMAC SHA256 om de uitdagingstekenreeks en het beveiligingstoken (of de geheime sleutel) te hashen (of combineren) om een hashhandtekening te vormen
- Antwoord aan FedEx met challengeString en challengeStringResponse samen in de responstekst, evenals HTTP-statuscode 200 (OK) of 202 (ACCEPTED).
- FedEx zal nu de uitdagingstekenreeks en het antwoord op de uitdagingstekenreeks valideren.
- Nadat de responstekst door FedEx is ontvangen, valideert FedEx de challengeString en challengeStringResponse (of de eerder gegenereerde hashhandtekening) door deze respectievelijk te vergelijken met de door FedEx gegenereerde challengeString en hashhandtekening.
- Als zowel de 'challengeString' als de HMAC-handtekeningen overeenkomen, is de validatie en workflow geslaagd. Zo niet, dan mislukt het validatieproces en wordt er een foutbericht weergegeven.
Webhookproject aanmaken
Stap 1:
Een webhookproject aanmaken om geconfigureerde meldingen over het laadvermogen te ontvangen
Op de pagina Mijn projecten gaat u naar het tabblad Webhooks.
Een beheerder of bijdrager van uw organisatie kan een webhookproject aanmaken door op de knop Een webhookproject aanmaken te klikken.
Voordat u aan de slag gaat, moet u ons eerst laten weten waarom u toegang wilt tot FedEx-webhooks. Er verschijnt een dialoogvenster met keuzelijstopties. U moet de optie selecteren die het beste aansluit bij uw bedrijfsbehoeften voor integratie met FedEx-webhooks.
Als u zich identificeert als afzender, kunt u beginnen met het aanmaken van uw project door de volgende stappen uit te voeren:
- Identificeer uw bedrijfsbehoeften
- Selecteer de optie die het beste aangeeft waarom uw bedrijf met FedEx-webhooks wil integreren.
- Selecteer het niveau en de niveaukenmerken
- Selecteer een basis- of geavanceerd webhookniveau voor uw project, gebaseerd op de behoeften van uw project.
- U kunt uw niveaukeuze later altijd nog wijzigen.
- Aan elk niveau zijn maandelijkse abonnementskosten verbonden.
- Selecteer de functies die u met uw project wilt configureren.
- U kunt deze functies ook later bewerken.
- Configureer de projectgegevens
- Geef uw project een herkenbare naam.
- Zorg voor een vooraf gegenereerd(e) bestemmings-URL en beveiligingstoken, die worden aangemaakt tijdens de vooraf ingestelde verificatie.
| Veldnaam | Omschrijving |
|---|---|
Webhook-projectnaam Bestemmings-URL |
Dit is een niet-lege, unieke webhook-projectnaam en deze mag in geen enkel ander webhookproject worden herhaald.
Dit is de URL waarop u de trackinggebeurtenisgegevens/laadgegevens zult ontvangen.
|
Beveiligingstoken |
Dit wordt gebruikt als gedeeld geheim om de respons van de tracking-webhook te verifiëren en valideren.
|
Taal van het laadvermogen (land) Trackingtype |
Selecteer de voorkeurstaal voor de vertalingen van uw trackinggegevens in de keuzelijst. Selecteer het responstype waarin de trackinggegevens moeten worden ontvangen.
|
E-mailadres |
Geef een e-mailadres op om e-mailmeldingen te ontvangen wanneer er wijzigingen zijn aangebracht in uw webhookproject (bijv. aangemaakt, bewerkt, geannuleerd). |
Taal van e-mails (land) |
Selecteer de voorkeurstaal waarin u webhook-e-mailmeldingen van FedEx wilt ontvangen. Dit zijn de ondersteunde talen voor e-mailmeldingen:
|
- Accounts kiezen
- Kies uit een lijst met in aanmerking komende accountnummers (in de VS of Canada) die u aan uw project wilt koppelen.
5. Gegevens bevestigen en voorwaarden accepteren
- Bekijk uw geconfigureerde projectgegevens.
- Lees en accepteer de Licentieovereenkomst voor de Developer Portal en bevestig dat u niet de intentie hebt om uw applicatie te distribueren.
- Lees en accepteer de Prijsovereenkomst.
- Zodra u op de knop Project aanmaken klikt:
- Als uw aanmaakaanvraag is gevalideerd en verwerkt, wordt u naar een bevestigingsscherm geleid.
- Als de validatie niet lukt of mislukt, wordt een foutbericht weergegeven.
- Uw tracking-webhookproject zal dan een door het systeem gegenereerde webhook-ID hebben en de status 'Actief' krijgen.
- FedEx zet een organisatie op voor Compatible-leveranciers.
- Uitnodiging accepteren.
- Nodig gebruikers uit voor uw organisatie.
- Kies de API's die u voor uw oplossing nodig hebt.
- FedEx zet project(en) op.
- Integreer API's in uw toepassing en certificeer uzelf volgens het Compatible-programma.
- FedEx brengt project(en) naar productie.
- Geheime sleutel voor productie genereren.
Stap 1:
FedEx maakt een organisatie aan voor compatibele providers
- FedEx maakt een organisatie aan 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.
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.
- 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.
Selecteer een API voor een overzicht, wijzigingslogboeken en de belangrijkste eigenschappen van die API.
Raadpleeg de documentatie van de API voor meer informatie over aanvraag- en responselementen, voorbeelden in de taal van uw keuze, foutobjecten en meer.
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.
- 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.
- 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.
- 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.
- 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.
- Implementeer uw oproepen aan deze eindpunten zoals beschreven in de voorbeeldaanvragen en configureer ze voor het gebruik van uw testgegevens.
- Verifieer of de ontvangen API-oproepreacties overeenkomen met die in de documentatie.
- Test uw implementatie volledig binnen de testomgeving van FedEx met testreferenties en de FedEx-test-URI's.
- 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 kunt dan uw geheime sleutel voor productie zien op het tabblad 'Productiesleutel' op de pagina 'Projectoverzicht'.
Stap 8:
Geheime sleutel voor productie genereren.
- Uw geheime productiesleutel moet gegenereerd worden door op de link Geheime sleutel 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!
