Per iniziare
FedEx Developer Portal offre una suite di Application Programming Interface (API) per integrare FedEx nei vostri tool. Queste istruzioni spiegano come configurare un'organizzazione, creare un progetto, testare l'integrazione, trasferire un progetto in produzione e, in alcuni casi, convalidare l'API.
Tipi di utenti:
FedEx offre servizi di integrazione a tre tipi di utenti, mittenti FedEx, soluzioni software verificate note come FedEx Compatible Provider e FedEx Integrator Provider convalidati.
Mittente FedEx:
azienda che spedisce con FedEx e ha bisogno di integrare API FedEx nei propri tool.
Provider di soluzioni o servizi:
Azienda che ha bisogno di integrare API FedEx per creare una soluzione, un tool o un plug-in che si possa vendere e/o distribuire a un'organizzazione esterna che spedisce con FedEx.
- FedEx Compatible Provider: azienda verificata con un accordo contrattuale attraverso il programma FedEx Compatible.
- FedEx Integrator Provider: azienda convalidata con un accordo contrattuale tramite il programma di integrazione FedEx.
Selezionate l'opzione sottostante che meglio descrive la vostra attività. A prescindere dal tipo di utente selezionato, esiste un'esperienza introduttiva adatta al vostro caso.
Effettuate una selezione per iniziare.
Se l'azienda non ha un'organizzazione, createne una. Altrimenti, partecipate a un'organizzazione esistente.
Creare una nuova organizzazione
Dalla barra di navigazione, cliccate su Crea o Unisciti a un'organizzazione.
Nota: in quanto creatori, sarete automaticamente indicati come amministratori dell'organizzazione.
Gli amministratori possono:
Invitare gli utente a partecipare
Assegnare ruoli agli utenti (ad es., collaboratore, visualizzatore) e progetti
Gestire i Codici Cliente di spedizione
Per ulteriori informazioni su questi ruoli, consultate la nostra Guida all'amministrazione dell'organizzazione.
Per il tipo di azienda, selezionate "Vende o fornisce una soluzione software che utilizza la tecnologia FedEx ed è un FedEx Integrator Provider convalidato".
Fornite il nome dell'azienda, l'URL del sito web e un nome univoco dell'organizzazione. Il nome dell'organizzazione può corrispondere al nome della vostra azienda o rappresentare un gruppo specifico (reparto, divisione, area, posizione). Queste informazioni sono necessarie per convalidare la vostra richiesta.
Nota: scegliete un nome per l'organizzazione che tutti gli altri utenti riconosceranno (ad es., nome dell'azienda, reparto, area, posizione).
Specificate la posizione della vostra azienda e dove verrà venduta o distribuita la soluzione software.
Aggiungere un Codice Cliente di fatturazione e autenticare il Codice Cliente di fatturazione
Nota: in qualità di fornitore di servizi di spedizione e logistica nel programma di integrazione FedEx, dovete utilizzare il vostro Codice Cliente. Non potete utilizzare il Codice Cliente FedEx di un cliente.
Inserite il vostro Codice Cliente FedEx. Se non disponete di un Codice Cliente FedEx, apritene uno su fedex.com oppure contattate un rappresentante dell'assistenza FedEx.
Inserite un soprannome per il Codice Cliente e l'indirizzo di fatturazione associato al Codice Cliente. Selezionate Avanti.
Nota: l'indirizzo di fatturazione deve corrispondere a quello presente nei nostri registri per questo Codice Cliente. Questo sarà il Codice Cliente di fatturazione predefinito dell'organizzazione.
Per completare la creazione dell'organizzazione, è necessario autenticare il Codice Cliente. Scegliere un'opzione di autenticazione (telefono disponibile solo per il trasportatore negli USA e in Canada, email, SMS) e selezionate Avanti.
Una volta ricevuto, inserite il codice di autenticazione e selezionate Invia.
Accetta i termini
Leggete l'Accordo di Integrazione globale e il Manuale del programma. Selezionate le caselle di controllo per confermare che accettate i termini e quindi selezionate Accetta.
Verrà visualizzata una schermata di conferma. Cliccate su Gestisci organizzazione per modificare i dettagli, se necessario.
Invitare utenti
Nota: solo gli amministratori possono invitare gli utenti.
Selezionate Gestisci organizzazione dal menu di navigazione a sinistra.
Passate alla scheda Utenti e selezionate Aggiungi utenti.
Compilate il modulo e assegnate il ruolo pertinente ai nuovi utenti: Visualizzatore, Collaboratore o Amministratore.
Per ulteriori informazioni sui ruoli utente, consultate la Guida all'amministrazione dell'organizzazione.
Assegnate utenti ai progetti (se pertinente) nel menu a discesa Progetti.
Inserite gli indirizzi email per ciascun utente e selezionate Invita.
Unirsi a un'organizzazione esistente
Richiedete un invito: chiedete all'amministratore dell'organizzazione di inviarvi un invito. Avete 24 ore per accettare l'invito prima che scada. Se necessario, chiedete all'amministratore di inviarlo nuovamente.
Accettate l'invito: effettuate l'accesso con l'ID utente e la password esistenti. Se il vostro ID è già collegato a un'altra organizzazione, dovete crearne uno nuovo.
Unitevi a un'organizzazione esistente
Fase 1: chiedete all'amministratore dell'organizzazione di inviarvi un invito.
Se l'azienda ha già creato un'organizzazione, chiedete all'amministratore di mandarvi l'invito a unirvi. Avete 24 ore per accettare l'invito. Se non riuscite a rientrare in questo limite temporale, potete chiedere di farvelo inviare di nuovo.
Fase 2: accettate l'invito.
Per accettare l'invito, dovrete effettuare l'accesso con i vostri ID utente e password esistenti oppure creare un nuovo ID utente se quello esistente è già associato a un'organizzazione.
Crea un progetto API
Visitate la pagina I miei progetti e aprite la scheda API. Cliccate sul pulsante Crea progetto API.
Fase 1: selezionate le API che volete includere nel progetto
Rivedete le quote API, i limiti tariffari e i dettagli sulla convalida API.
Fase 2: configurate i dettagli del progetto
- Assegnate al progetto un nome identificabile che sia esclusivo alla vostra organizzazione.
- Selezionate eventuali Paesi/territori verso cui intendete spedire, così da potervi assegnare un Codice Cliente di prova. Per testare colli di spedizioni a livello nazionale all'interno di un Paese/territorio europeo, dovete avere un Codice Cliente di prova distinto per ogni Paese/territorio. Potete comunque aggiungere/rimuovere i Paesi/territori in un secondo momento.
- Per ricevere le notifiche sugli ultimi aggiornamenti API ed eventuali informazioni relative all'interruzione, impostate le preferenze di notifica.
Fase 3: leggete e accettate i termini, incluso l'Accordo di licenza di FedEx Developer Portal
Una volta accettati i termini e cliccato sul pulsante Crea, comparirà una schermata di conferma. Potete visualizzare le credenziali di prova all'interno del vostro nuovo progetto.
Creare progetti webhook
Create un URL (callback) valido nel tool o nella piattaforma di destinazione
L'URL di destinazione verrà utilizzato per ricevere messaggi e codici di autenticazione, così come le notifiche di payload dei webhook da FedEx. Per garantire la sicurezza, l'URL deve utilizzare il protocollo HTTPS. L'URL verrà bloccato se include:
- Spazio IP RFC1918
- fedex.com o uno dei relativi sottodomini
- Indirizzi IP nell'URL (compreso localhost, 127.0.0.1)
Generate un token di sicurezza
Questo token di sicurezza può essere usato come chiave segreta per autenticare e convalidare le informazioni trasmesse tra la vostra organizzazione e FedEx. Il token di sicurezza deve includere:
- un minimo di 26 e un massimo di 100 caratteri
- 1 carattere maiuscolo
- 1 carattere minuscolo
- 1 carattere numerico
Esempio: Y1F6OiVUQW2JPSElmRE9U0IY5
Dopo aver definito l'URL e il token di sicurezza, potete procedere alla creazione di un progetto webhook. Visitate la pagina I miei progetti e aprite la scheda Webhook. Cliccate sul pulsante Crea un progetto webhook.
Selezionate il tipo di iscrizione
I mittenti FedEx possono iscrivere gli eventi ai Codici Cliente o ai numeri di monitoraggio.
Fase 1: confermate il Codice Cliente di fatturazione e selezionate le funzionalità
- Rivedete il Codice Cliente di fatturazione predefinito elencato per confermarlo o selezionare un altro Codice Cliente disponibile nell'organizzazione.
- Configurate il progetto selezionando funzionalità come opzioni di prova di consegna, opzioni di consegna stimata, eventi di monitoraggio e applicazione di filtri basata sugli eventi.
Fase 2: inserite i dettagli del progetto
- Assegnate al progetto un nome identificabile che sia esclusivo alla vostra organizzazione.
- Inserite l'URL di destinazione e i dettagli del token di sicurezza creati durante l'autenticazione preconfigurazione (si vedano le fasi precedenti).
- Per ricevere le notifiche sugli ultimi aggiornamenti dei webhook ed eventuali informazioni relative a interruzioni, inserite un indirizzo email e la lingua preferita.
Fase 3: leggete e accettate i termini
Una volta accettati i termini, inclusi l'Accordo di licenza di FedEx Developer Portal e il Modulo d'ordine, e cliccato sul pulsante Crea, comparirà una schermata di conferma.
A seconda della selezione del tipo di iscrizione, possono essere previste ulteriori fasi. Maggiori informazioni sono disponibili nella documentazione.
Nella pagina Panoramica del progetto API, recuperate le credenziali di prova (chiave API, chiave segreta e Codice/i Cliente di spedizione) dalla scheda Chiave test.
Fase 1: richiedete un token di accesso OAuth
Il token di accesso OAuth deve essere utilizzato con ogni transazione API. La sessione per il token è valida solo per un'ora, quindi dovrete codificare il tool in maniera programmatica per aggiornare il token prima che la sessione scada. Maggiori informazioni sono disponibili nella documentazione di API Authorization.
Fase 2: rivedete la documentazione API
Cliccate sulla documentazione relativa a ciascuna delle API per leggere il contesto aziendale e capire come utilizzarla. Effettuate il login per scaricare la raccolta di API JSON attraverso il pulsante in testa alla pagina della documentazione. Potete anche riesaminare le richieste di esempio per l'endpoint che corrisponde all'integrazione desiderata.
Fase 3: utilizzate la sandbox per testare le transazioni campione
Cliccate sull'endpoint desiderato nella barra di navigazione a sinistra per aprire quella sandbox specifica. Identificate le richieste campione che corrispondono al vostro caso d'uso e utilizzate le credenziali di prova e gli URL di test FedEx per implementare le chiamate all'endpoint così come descritto nelle richieste di esempio. Verificate che le risposte ricevute alle chiamate API corrispondano a quelle mostrate nella documentazione. Maggiori informazioni sull'esperienza di test sono disponibili nella Guida alla virtualizzazione della sandbox.
Test con i webhook
Il test aiuta a capire se l'URL che avete creato è valido. Consente a FedEx di identificare l'URL e creare una connessione per inviare dati. Inoltre, può fornire dati di test campione che aiutano a verificare e confermare se siete in grado di elaborare i dati di monitoraggio forniti nel vostro tool. Tuttavia, il test non autentica l'URL. Per scoprire come testare l'URL del webhook, consultate la documentazione del webhook.
Visitate la pagina Panoramica del progetto e aprite la scheda Chiave di produzione. I progetti di Iscrizione del Codice Cliente di Visibilità integrata avanzata non richiedono il trasferimento alla produzione.
Fase 1: configurate il progetto
- Rinominate la chiave in base alle esigenze.
- Controllate il numero del Codice Cliente selezionato nel passaggio 1 del flusso di creazione del progetto. Questo viene usato per spostare il progetto in produzione. Quando il progetto passa attivamente alla fase di produzione, potete aggiungere ulteriori Codici Cliente in base alle esigenze.
Fase 2: ottenete le chiavi del progetto
Copiate la chiave API di produzione. La chiave segreta di produzione verrà visualizzata in un luogo sicuro. Per garantire la massima sicurezza, la chiave segreta di produzione verrà visualizzata solo una volta. Se la perdete, è possibile generarne una nuova.
Dopo aver ottenuto le chiavi del progetto e aver cliccato su Avanti, nella scheda Chiave di produzione verranno visualizzati i dettagli del progetto.
- Per aggiungere ulteriori Codici Cliente di spedizione al progetto, cliccate su Modifica nella parte superiore della tabella dei Codici Cliente di spedizione.
Alcune API richiedono una convalida dell'etichetta di spedizione per l'utilizzo nel nostro ambiente di produzione. Scoprite se la vostra API richiede la convalida.
Step 1: Sviluppate e testate API FedEx con la vostra applicazione con accesso web
Una volta terminato lo sviluppo della vostra applicazione con accesso web, dovrete completare la fase di test utilizzando le credenziali di prova (codici cliente di prova, Chiave API e Chiave Segreta). La vostra Chiave API e la Chiave Segreta verranno mostrate nella pagina di Riepilogo Progetto e saranno consultabili in qualsiasi momento.
Passaggio 2: Spostate il vostro progetto in produzione
Dopo il test con le API FedEx, dovrete avviare il processo di convalida spostando il progetto in produzione nel FedEx Developer Portal. Una volta completata questa operazione, vedrete la Chiave API e la Chiave segreta di produzione. La Chiave Segreta di produzione verrà visualizzata una sola volta, ma potrete rigenerarla in un secondo momento.
Passaggio 3: Compilate la cover dell'etichetta
Compilate per intero il Frontespizio dell'etichetta con le informazioni di contatto corrette e i servizi che desiderate implementare. Includete inoltre il vostro Codice Cliente e la chiave di produzione.
Fase 4: generate e inoltrate le etichette di prova al gruppo di analisi del codice a barre
Generate le etichette di prova nell'ambiente di prova FedEx associato al tool, quindi inviatele al team FedEx addetto alla valutazione delle etichette per ottenere l'approvazione. Il gruppo di analisi del codice a barre necessita di tre giorni lavorativi per la valutazione delle etichette.
Per evitare ritardi nell'elaborazione, seguite queste best practice:
- Le etichette devono essere stampate e scansionate con una risoluzione di almeno 600 DPI. NON INVIATE FILE GENERATI DA API.
- Per le stampanti termiche, il tipo di immagine dell'etichetta deve essere richiesto in base al modello della stampante. Ad esempio: ZPLII per le stampanti Zebra
- Quando create le etichette campione per la valutazione, utilizzate gli indirizzi del mittente/destinatario. Create etichette campione esclusivamente per i servizi specifici per cui si fa richiesta.
- L'etichetta Pagamento in contrassegno (C.O.D.) FedEx® deve includere anche l'etichetta di reso C.O.D. corrispondente.
- Le spedizioni FedEx International Express® devono includere anche l'etichetta della Lettera di Vettura Aerea aggiuntiva/secondaria.
- Le spedizioni multicollo devono includere un'etichetta per ciascun collo nella spedizione.
- Inviate un'email con il PDF e il Frontespizio dell'etichetta a label@fedex.com.
- Le etichette cartacee vanno inviate all'indirizzo seguente:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
Se non presentano difetti visibili (ad esempio linee che attraversano il codice a barre, macchie di inchiostro o danni fisici di altro tipo), le etichette scansionate passeranno l'ispezione e verranno approvate.
Se inviate etichette cartacee, fate attenzione alla qualità di stampa e all'allargamento/restringimento accidentale delle etichette (ad es. ridimensionamento in scala). Questi sono i due motivi principali per cui le etichette non superano il processo di valutazione.
Fase 5: rivedete la valutazione dell'etichetta
Il gruppo di analisi del codice a barre valuterà le etichette di prova presentate, approvandole o rifiutandole. Verrete contattati da parte del gruppo riguardo il superamento o meno della valutazione. Se le etichette sono approvate, proseguirete con lo step successivo. In caso contrario, dovrete correggere le etichette come indicato e ripresentarle per una nuova valutazione.
Fase 6: abilitate il tool
Una volta che le etichette di prova ottengono l'approvazione per la produzione, il gruppo di analisi del codice a barre autorizzerà le credenziali di produzione a trasmettere la transazione con l'etichetta di spedizione identificata e invierà una notifica via email dell'avvenuta convalida. L'approvazione si basa sul singolo progetto.
Passaggio 7: Sostituite URL e credenziali
Sostituite l'URL e le credenziali di prova con quelle di produzione. Testate di nuovo l'implementazione nell'ambiente di produzione utilizzando i dati di esempio.
Fase 1: ricevete l'invito a unirvi all'organizzazione
FedEx creerà un'organizzazione e quindi inviterà un membro del team a unirsi all'organizzazione. Questo utente verrà designato come amministratore per l'organizzazione.
Fase 2: accettate l'invito
Per accettare l'invito, dovrete effettuare l'accesso con i vostri ID utente e password esistenti oppure creare un nuovo ID utente se quello esistente è già associato a un'organizzazione.
Fase 3: invitate gli utenti
Un amministratore può invitare gli utenti nell'organizzazione e assegnarli a ruoli e progetti. Aprite la scheda Utenti. Cliccate sul pulsante Aggiungi utenti.
- Selezionate un ruolo utente: Visualizzatore, Collaboratore o Amministratore. Maggiori informazioni sui ruoli sono disponibili nella Guida all'amministrazione dell'organizzazione.
- Se disponete di progetti esistenti, assegnate un progetto all'utente. È anche possibile assegnare gli utenti ai progetti attraverso la pagina Panoramica del progetto.
- Inserite gli indirizzi email degli utenti che desiderate si uniscano all'organizzazione nel ruolo selezionato.
Visitate il Catalogo API per stabilire quali sono le API o i webhook migliori per la vostra soluzione. Il FedEx Customer Technology Consultant (CTC) e il Compatible Channel Manager di riferimento possono aiutarvi a selezionare le API più adatte alla soluzione in base alle esigenze aziendali.
Fase 1: compilate il PIW
Tornate nella Compatible Provider Community (CPC) per compilare il Product Information Worksheet (PIW).
Fase 2: rivedete i progetti creati da FedEx
Una volta approvato il PIW, FedEx creerà i vostri progetti. Ogni versione di ciascuna delle soluzioni avrà un progetto separato in FedEx Developer Portal.
Fase 3: partecipate alla demo delle API con il team
Il team FedEx Compatible insieme ai team di verifica e CTC FedEx organizzeranno una dimostrazione tecnica per le API con il vostro team. Il team FedEx tratterà la verifica del programma Compatible, le nuove caratteristiche e funzionalità API e risponderà alle domande.
Nella pagina Panoramica del progetto API, recuperate le credenziali di prova (chiave API e chiave segreta) dalla scheda Chiave test.
Fase 1: create le chiavi cliente
Utilizzate l'API registrazione credenziali per creare le chiavi cliente. Si tratta di un'API privata che si trova solo nella sezione API in fondo alla pagina Panoramica del progetto API.
Fase 2: richiedete un token di accesso OAuth
Il token di accesso OAuth deve essere utilizzato con ogni transazione API. La sessione per il token è valida solo per un'ora, quindi dovrete codificare il tool in maniera programmatica per aggiornare il token prima che la sessione scada. Maggiori informazioni sono disponibili nella documentazione di API Authorization. Durante la visualizzazione del codice campione, assicuratevi che nel menu a tendina dei campioni sia selezionata l'opzione "Rivenditore".
Fase 3: rivedete la documentazione API
Cliccate sulla documentazione relativa a ciascuna delle API per leggere il contesto aziendale e capire come utilizzarla. Effettuate il login per scaricare la raccolta di API JSON attraverso il pulsante in testa alla pagina della documentazione. Potete anche riesaminare le richieste di esempio per l'endpoint che corrisponde all'integrazione desiderata.
Fase 4: utilizzate la sandbox per testare le transazioni campione
Cliccate sull'endpoint desiderato nella barra di navigazione a sinistra per aprire quella sandbox specifica. Identificate le richieste campione che corrispondono al vostro caso d'uso e utilizzate le credenziali di prova e gli URL di test FedEx per implementare le chiamate all'endpoint così come descritto nelle richieste di esempio. Verificate che le risposte ricevute alle chiamate API corrispondano a quelle mostrate nella documentazione. Maggiori informazioni sull'esperienza di test sono disponibili nella Guida alla virtualizzazione della sandbox.
Fase 5: verificate ogni soluzione
Dopo aver testato completamente le soluzioni, inoltrate i casi di test al team di verifica per verificare ogni soluzione. FedEx sottoporrà tutti gli elementi inoltrati a una revisione completa e vi aggiornerà una volta approvata la certificazione.
Test con i webhook
Se la vostra organizzazione dispone dell'accesso ai webhook, il test può aiutarvi a capire se l'URL creato è valido. Consente a FedEx di identificare l'URL e creare una connessione per inviare dati. Inoltre, può fornire dati di test campione che aiutano a verificare e confermare se siete in grado di elaborare i dati di monitoraggio forniti nel vostro tool. Tuttavia, il test non autentica l'URL. Per scoprire come testare l'URL del webhook, consultate la documentazione del webhook.
FedEx sposterà quindi i vostri progetti in produzione. Visitate la pagina Panoramica del progetto API e aprite la scheda Chiave di produzione. Cliccate sul link Genera chiave segreta nella colonna Chiave segreta.
È ora possibile ripetere il test della propria implementazione nell'ambiente di produzione utilizzando dati di esempio.
Create un'organizzazione, se per la vostra azienda non ne esiste ancora una, oppure unitevi all'organizzazione esistente della vostra azienda.
Create una nuova organizzazione
Dalla barra di navigazione, cliccate su Crea o Unisciti a un'organizzazione.
Nota: in quanto creatori, sarete automaticamente indicati come amministratori dell'organizzazione.
Gli amministratori possono:
Invitare gli utenti a partecipare
Assegnare ruoli agli utenti (ad es., collaboratore, visualizzatore) e progetti
Gestire i Codici Cliente di spedizione
Per ulteriori informazioni su questi ruoli, consultate la nostra Guida all'amministrazione dell'organizzazione.
Per il tipo di azienda, selezionate "Vende o fornisce una soluzione software che utilizza la tecnologia FedEx ed è un FedEx Integrator Provider convalidato".
Fornite il nome dell'azienda, l'URL del sito web e un nome univoco dell'organizzazione. Il nome dell'organizzazione può corrispondere al nome della vostra azienda o rappresentare un gruppo specifico (reparto, divisione, area, posizione). Queste informazioni sono necessarie per convalidare la vostra richiesta.
Nota: scegliete un nome per l'organizzazione che tutti gli altri utenti riconosceranno (ad es., nome dell'azienda, reparto, area, posizione).
Specificate la posizione della vostra azienda e dove verrà venduta o distribuita la soluzione software.
Aggiungere un Codice Cliente di fatturazione e autenticare il Codice Cliente di fatturazione
Nota: in qualità di fornitore di servizi di spedizione e logistica nel programma di integrazione FedEx, dovete utilizzare il vostro Codice Cliente. Non potete utilizzare il Codice Cliente FedEx di un cliente.
Inserite il vostro Codice Cliente FedEx. Se non disponete di un Codice Cliente FedEx, apritene uno su fedex.com oppure contattate un rappresentante dell'assistenza FedEx.
Inserite un soprannome per il Codice Cliente e l'indirizzo di fatturazione associato al Codice Cliente. Selezionate Avanti.
Nota: l'indirizzo di fatturazione deve corrispondere a quello presente nei nostri registri per questo Codice Cliente. Questo sarà il Codice Cliente di fatturazione predefinito dell'organizzazione.
Per completare la creazione dell'organizzazione, è necessario autenticare il Codice Cliente. Scegliere un'opzione di autenticazione (telefono disponibile solo per il trasportatore negli USA e in Canada, email, SMS) e selezionate Avanti.
Una volta ricevuto, inserite il codice di autenticazione e selezionate Invia.
Accetta i termini
Leggete l'Accordo di Integrazione FedEx e il Manuale del programma. Selezionate le caselle di controllo per confermare che accettate i termini e quindi selezionate Accetta.
Verrà visualizzata una schermata di conferma. Cliccate su Gestisci organizzazione per modificare i dettagli, se necessario.
Invitare utenti
Nota: solo gli amministratori possono invitare gli utenti.
Selezionate Gestisci organizzazione dal menu di navigazione a sinistra.
Passate alla scheda Utenti e selezionate Aggiungi utenti.
Compilate il modulo e assegnate il ruolo pertinente ai nuovi utenti: Visualizzatore, Collaboratore o Amministratore.
Per ulteriori informazioni sui ruoli utente, consultate la Guida all'amministrazione dell'organizzazione.
Assegnate utenti ai progetti (se pertinente) nel menu a discesa Progetti.
Inserite gli indirizzi email per ciascun utente e selezionate Invita.
Unirsi a un'organizzazione esistente
Richiedete un invito: chiedete all'amministratore dell'organizzazione di inviarvi un invito. Avete 24 ore per accettare l'invito prima che scada. Se necessario, chiedete all'amministratore di inviarlo nuovamente.
Accettate l'invito: effettuate l'accesso con l'ID utente e la password esistenti. Se il vostro ID è già collegato a un'altra organizzazione, dovete crearne uno nuovo.
Creare un progetto API
Passate alla pagina I miei progetti e selezionate Crea progetto.
Compilate il campo Nome del progetto. Il formato del nome consigliato è "Projectname_applicationname". Selezionate Avanti al termine.
Selezionate l'API e i prodotti di visibilità integrata avanzata per il vostro progetto.
Nota: i prodotti di visibilità integrata avanzata sono disponibili solo per i FedEx Integrator Provider negli Stati Uniti.
Nota: se selezionate prodotti a pagamento, vi verrà chiesto di assegnare un Codice Cliente di fatturazione al progetto e di accettare i termini richiesti.
Assegnare la fatturazione e accettare i termini
Assegnate un Codice Cliente di fatturazione dall'elenco di Codici Cliente aggiungi all'organizzazione. Questo passaggio è necessario solo se in precedenza avete selezionato un prodotto a pagamento.
Accettate i Termini e Condizioni associati al prodotto.
Confermare i dettagli
Rivedete i prodotti selezionati. Verificate il Codice Cliente di fatturazione fornito.
Consultate e accettate l'Accordo di licenza per il FedEx Developer Portal.
Cliccate su Crea per generare il progetto e visualizzare le credenziali di test.
Configurare la visibilità integrata avanzata in un progetto
Prerequisiti
Create un URL di callback valido nell'applicazione e nella piattaforma di destinazione - L'URL dell'applicazione/della piattaforma:
Deve usare HTTPS per garantire la sicurezza.
Non può includere lo spazio IP RFC1918, sottodomini fedex.com o indirizzi IP diretti (ad es. 127.0.0.1).
Generare un token di sicurezza
Deve contenere da 26 a 100 caratteri e includere:
- 1 lettera maiuscola
- 1 lettera minuscola
- 1 numero
Esempio: Y1F6OiVUQW2JPSElmRE9U0IY5
Configurare la Visibilità integrata avanzata
Scegliete Visibilità integrata avanzata. Selezionate funzionalità come la prova di consegna, la consegna stimata, gli eventi di monitoraggio e il filtro basato sugli eventi
Inserite l'URL di destinazione e il token di sicurezza.
Fornite un'email per gli aggiornamenti della visibilità integrata avanzata e le notifiche sulle interruzioni.
Confermare i dettagli
Rivedete e accettate l'Accordo di licenza FedEx Developer Portal e il Modulo d'ordine.
Selezionate Crea per completare la configurazione.
Nota: potrebbero essere necessari passaggi aggiuntivi in base al tipo di sottoscrizione. Fate riferimento alla documentazione per i dettagli.
Recuperate le credenziali di test e iniziate la verifica
Consultate la documentazione API
- Leggete la documentazione API per scoprire le diverse API che offriamo, oltre al relativo contesto aziendale e ai processi di integrazione.
- Scaricate lo schema JSON dalla pagina di documentazione dell'API pertinente.
- Esaminate le richieste di esempio per gli endpoint desiderati.
Ottenete le credenziali
Nella pagina Panoramica del progetto, passate alla scheda Chiavi API. La vostra chiave API e la chiave segreta sono elencate nell'intestazione Chiave test.
Consultate la documentazione API
- Un token OAuth è richiesto per tutte le transazioni API e scade tra un'ora.
- L'applicazione deve aggiornare il token prima che scada.
- Maggiori informazioni sono disponibili nella documentazione di API Authorization.
Testate le transazioni API nella sandbox
- Passate all'API pertinente nel Catalogo API e selezionate Documentazione.
- Selezionate l'endpoint API desiderato nel menu a sinistra.
- Usate le richieste di esempio che corrispondono al vostro caso d'uso.
- Implementate le chiamate API con le vostre credenziali di test e gli URL di test FedEx.
- Verificate le risposte in base alla documentazione.
- Per maggiori dettagli, fate riferimento alla Guida alla virtualizzazione della sandbox.
Testare la visibilità integrata avanzata
La verifica della visibilità integrata avanzata convalida il formato dell'URL e consente di stabilire una connessione tra FedEx e la vostra applicazione.
Il test offre dati di test di esempio per l'elaborazione delle informazioni di monitoraggio.
Nota: la verifica non autentica l'URL.
Per ulteriori informazioni, visitate la documentazione sulla visibilità integrata avanzata.
È richiesta la convalida per spostare le API in produzione. Il livello di convalida può variare a seconda dell'API.
Sviluppare e testare le API FedEx
- Utilizzate le credenziali di test (chiave API e chiave segreta) dalla pagina Panoramica del progetto.
- Identificate i casi di test per i territori/regioni in cui pianificate di distribuire la vostra soluzione (consultate i riferimenti di base per i casi di test relativi all'Integratore).
- Prima di eseguire i casi di test, completate le transazioni di registrazione usando i Codici Cliente di test forniti.
- Eseguite tutti i casi di test richiesti.
Passate alla pagina Panoramica del progetto.
Selezionate Richiedi chiavi di produzione. FedEx riceverà la vostra richiesta per le chiavi di produzione e riceverete una notifica una volta approvate.
Compilare il PIW e il frontespizio della convalida
Compilate il Product Information Worksheet (PIW) e il Frontespizio della convalida del trasportatore con le vostre informazioni di contatto e i servizi FedEx previsti.
Inviare i deliverable
Raccogliete e comprimete quanto segue in un file ZIP per evitare restrizioni da parte dei provider di posta. Inviate all'indirizzo validationmtp@fedex.com.
Deliverable richiesti
- PIW compilato (PDF).
- Frontespizio della convalida compilato (PDF).
Screenshot (PDF):
La soluzione rivolta al cliente indicante servizi/gestione speciale FedEx
Dichiarazione di esclusione di responsabilità
Accordo di licenza utente finale
Flusso di registrazione del cliente finale
- Transazioni di registrazione del cliente finale con autenticazione a più fattori (JSON)
- Etichette di spedizione scansionate per tutti i casi di test applicabili (PDF/PNG)
- Transazioni di spedizione per i formati di etichetta: PDF, PNG e ZPL (JSON) (per le API applicabili di spedizione e tariffe)
Best practice per evitare i ritardi
- Le etichette devono essere stampate e scansionate a una risoluzione minima di 600 DPI.
- Le etichette delle stampanti termiche devono corrispondere al modello della stampante (ad esempio, ZPLII per stampanti Zebra).
- Le spedizioni FedEx International Express® richiedono un'etichetta della Lettera di Vettura Aerea (AWB) aggiuntiva.
- Le spedizioni multicollo (MPS) devono includere un'etichetta per ciascun collo.
Valutazione dell'etichetta
Il team di convalida approverà o rifiuterà quanto presentato.
- Se rifiutato, apportate le correzioni e rinviate in base al feedback
- Se approvato, riceverete un'email di conferma della convalida riuscita. Una volta ricevuta l'email, le vostre credenziali di produzione saranno autorizzate per le transazioni di etichette di spedizione.
Seguire le istruzioni post-convalida
Rivedete e implementate eventuali requisiti di post-convalida, se necessario.
Una volta ricevuta la notifica che le vostre chiavi di produzione sono state approvate, recuperatele dalla scheda Panoramica del progetto.
- Copiate e conservate in modo sicuro la vostra chiave API di produzione e la chiave segreta.
- La chiave segreta viene mostrata solo una volta—se persa, è necessario generarne una nuova.

