1. Create un progetto per ottenere le credenziali
2. Integrate le API e tastate l'implementazione
3. Spostate il vostro progetto in produzione
4. Completate la certificazione

Un Amministratore o un Collaboratore per l'organizzazione può creare un progetto API cliccando sul pulsante Creare un progetto API.

Prima di iniziare, dovrete farci sapere il motivo per cui volete accedere alle API FedEx. Apparirà una finestra modale e vi mostrerà le opzioni del menù a tendina. Dovrete selezionare l'opzione che meglio identifica le vostre esigenze aziendali per l'integrazione delle API FedEx.

Se vi identificate come mittente, potete iniziare a creare il progetto. È un processo in tre fasi:

Seleziona le API

Selezionate le API che volete includere nel progetto. In base alle API selezionate, potreste dover effettuare alcune selezioni aggiuntive.

Se selezionate API monitoraggio, dovrete anche:

• Selezionare un Codice Cliente da associare alla chiave di produzione.
• Rivedere il monitoraggio delle quote API, i limiti tariffari e i dettagli sulla certificazione API.
• Scegliere se volete ricevere o meno le e-mail che vi avvisano se superate la quota di transazione.

Configura il progetto

Inserite le specifiche del progetto, inclusi nome e luogo di spedizione.

• Fornite al progetto un nome identificabile che sia unico per la 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, potete impostare le preferenze di notifica.

Confermate i dettagli

Controllate i dettagli del progetto, quindi accettate i Termini e le Condizioni.

• Leggete e accettate l'Accordo di licenza FedEx Developer Portal e acconsentite a non vendere o distribuire l'applicazione.
• Dopo aver cliccato sul pulsante "Creare", vedrete una schermata di conferma. Potete visualizzare le credenziali di prova all'interno del vostro nuovo progetto.

• Richiedere un token di accesso OAuth che deve essere utilizzato per ogni transazione API. La sessione per il token è valida solo per un'ora, quindi dovrete codificare l'applicazione in maniera programmatica per aggiornare il token prima che la sessione scada. Fate riferimento ai documenti dell'Autorizzazione API per maggiori informazioni
• Cliccare su qualsiasi Documento API per leggere il contesto commerciale per ciascuna API così potete comprendere meglio come utilizzarla. Potete anche riesaminare le richieste d'esempio per il terminale che corrisponde all'integrazione desiderata.
• Implementare le chiamate verso questi terminali come descritto nelle richieste d'esempio, configurandole con le credenziali di prova.
• Verificare che le risposte ricevute alle chiamate API corrispondano a quelle mostrate nella documentazione.
• Testare l'implementazione all'interno dell'ambiente di prova FedEx utilizzando credenziali e URL di prova FedEx.

Nel passaggio Configurate il progetto:

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

Nel passaggio Ottieni le chiavi del progetto:

• Verranno visualizzate la chiave API di produzione e la chiave segreta di produzione. Accertatevi di copiarle in un luogo sicuro.
• La chiave segreta di produzione verrà visualizzata solo una volta per garantire la massima sicurezza. Se la perdete, potete generarne una nuova.
• Cliccate su Avanti.

Adesso verrete indirizzati nuovamente alla pagina Panoramica del progetto. Qui potete aggiungere ulteriori Codici Cliente associati al progetto.

Nella pagina Panoramica del progetto:

• Cliccate sui 3 punti in verticale (o menù kebab) per aggiungere ulteriori Codici Cliente associati al progetto.
• Successivamente, cliccate su Modificare.

Questo passaggio vi indirizzerà alla pagina Chiave API in cui potete aggiungere ulteriori Codici Cliente da associare alla chiave di produzione per questo progetto.

1. Alcune API richiedono una certificazione dell'etichetta di spedizione per l'utilizzo nel nostro ambiente di produzione. Completate il processo di certificazione per qualsiasi API nel vostro progetto con questo requisito.

1. Dopo che tutte le API sono state certificate e abilitate, aggiornate le richieste API sostituendo le URI, le chiavi e i Codici Cliente di spedizione di prova con le URI, le chiavi e i Codici Cliente di spedizione di produzione.

2. Testate di nuovo l'implementazione nell'ambiente di produzione utilizzando i dati di esempio.

3. Approfittate dei vantaggi della nuova integrazione!

Prerequisiti per creare un progetto webhook

1. Create un URL valido nell'applicazione/piattaforma di destinazione
2. Generate un token di sicurezza
3. Testate l'URL del webhook
4. Convalidate l'URL di destinazione

Creare progetti webhook

1. Create un progetto webhook per ricevere notifiche del carico utile configurato

Prerequisiti per creare un progetto webhook

Create un URL valido nell'applicazione/piattaforma di destinazione per ricevere codici di autenticazione/messaggi e notifiche del carico utile del tracking webhook da FedEx.

Requisiti dell'URL:

Questo token di sicurezza può essere usato come chiave segreta per autenticare e convalidare le informazioni trasmesse tra voi (il cliente) e FedEx.

Requisiti del token di sicurezza:

• minimo 25 e massimo 100 caratteri
• 1 carattere maiuscolo
• 1 carattere minuscolo
• 1 carattere numerico

Il test dell'URL è un passaggio facoltativo che potrebbe esservi utile.

Il test vi aiuta a capire se l'URL che avete creato nel passaggio 1 è valido. Consente a FedEx di identificare l'URL e creare una connessione per inviare dati; può anche fornirvi dati di test di esempio che vi aiutano a verificare e confermare che riusciate a elaborare i dati di monitoraggio forniti nell'applicazione. Tuttavia, il test non autentica l'URL.

Consultate la nostra documentazione webhook per scoprire come testare l'URL del webhook.

Utilizzando il metodo dell'algoritmo di hashing HMAC SHA256, impostate un processo di autenticazione per convalidare le informazioni trasmesse tra il vostro URL di destinazione e FedEx.

1. Quando cliccate su Creare, FedEx genera una stringa di verifica casuale che vi viene inviata nel corpo della richiesta. Dovrete poi restituire questa stringa di verifica a FedEx nel corpo della risposta.

1. Avviate il codice di autenticazione del messaggio (MAC) utilizzando l'algoritmo/la procedura HMAC SHA256 per eseguire l'hash (o combinazione) della stringa di verifica e del token di sicurezza (o chiave segreta) per formare una firma hash

1. Inviate una risposta a FedEx con challengeString e challengeStringResponse nel corpo della risposta, insieme al codice di stato HTTP 200 (OK) o 202 (ACCETTATO).

1. FedEx ora convaliderà la stringa di verifica e la risposta della stringa di verifica.

• Dopo che FedEx avrà ricevuto il corpo della risposta, convaliderà la challengeString e la challengeStringResponse (o la firma hash generata in precedenza) confrontandole rispettivamente con la challengeString e la firma hash generate da FedEx.

• Se la "challengeString" e le firme HMAC corrispondono, allora la convalida e il flusso di lavoro sono andati a buon fine. In caso contrario, il processo di convalida non sarà andato a buon fine e verrà visualizzato il relativo messaggio di errore.

Creare progetti webhook

Nella pagina I miei progetti, andate nella scheda Webhook.

Un Amministratore o un Collaboratore per la vostra organizzazione può creare un progetto webhook cliccando sul pulsante del progetto Creare un webhook.

Prima di iniziare, dovrete farci sapere il motivo per cui volete accedere ai webhook FedEx. Apparirà una finestra modale e vi mostrerà le opzioni del menù a tendina. Dovrete selezionare l'opzione che meglio identifica le esigenze aziendali per l'integrazione dei webhook FedEx.

Se vi identificate come mittente, potete iniziare a creare il vostro progetto completando i passaggi seguenti:

1. Identificate le vostre esigenze aziendali

• Selezionate l'opzione che meglio identifica il motivo per cui l'azienda vuole integrare i webhook FedEx.

1. Selezionate una fascia e le relative funzioni

• Selezionate una fascia webhook di base o avanzata per il vostro progetto, in base alle esigenze.
• Potrete sempre modificare la scelta della fascia in un secondo momento.
• Ogni fascia prevede una quota di iscrizione mensile.

• Selezionate le funzioni che volete vengano configurate con il progetto.
• Potete anche modificare le funzioni in un secondo momento.

1. Configurate i dettagli del progetto

• Fornite al progetto un nome identificabile
• Fornite i dettagli del token di sicurezza e l'URL di destinazione pre-generati che vengono creati durante l'autenticazione pre-configurazione.

Scegliete i Codici Cliente

• Scegliete da un elenco i Codici Cliente idonei (con sede negli Stati Uniti o in Canada) che volete siano associati al progetto.

  5. Confermate i dettagli e accettate i termini

• Controllate i dettagli del progetto configurati.
• Leggete e accettate l'Accordo di licenza del Developer Portal e acconsentite a non distribuire l'applicazione.
• Leggete e accettate l'Accordo sulle tariffe.
• Una volta cliccato sul pulsante Creare progetto:

1. Se la richiesta di creazione è stata convalidata ed elaborata correttamente, sarete indirizzati a una schermata di conferma.

• Se la convalida ha avuto esito negativo o non è riuscita, apparirà un messaggio di errore.

1. Il progetto tracking webhook avrà quindi un ID webhook generato dal sistema e verrà mostrato con lo stato "Attivo".

1. FedEx crea un'organizzazione di fornitori Compatible.
2. Accettate l'invito.
3. Invitate gli utenti alla vostra organizzazione.
4. Selezionate le API necessarie per la vostra soluzione.
5. FedEx crea i progetti.
6. Integra le API nella vostra applicazione e certifica per il programma Compatible.
7. FedEx trasferisce i progetti in produzione.
8. Generare la chiave di produzione segreta.

• FedEx creerà un'organizzazione e quindi inviterà un membro del team a unirsi all'organizzazione. Questo utente verrà designato come amministratore per l'organizzazione.
• Dopo aver completato la certificazione e l'integrazione, sarete in grado di distribuire facilmente la soluzione ai vostri clienti.

• Per accedere agli artefatti e alla documentazione di integrazione API, accettate l'invito. Per accettare l'invito, dovrete accedere con il vostro ID utente FedEx e la password o crearne uno nuovo se non avete già le credenziali.

• In qualità di amministratore, potete invitare tutti i membri del team che necessitano dell'accesso al progetto o all'organizzazione. Per i dettagli sui diversi ruoli, consultare la Guida all'amministrazione dell'organizzazione.

• Se la vostra organizzazione è già stata creata, chiedete all'amministratore dell'organizzazione o a FedEx di invitarvi a partecipare. Avete 24 ore per accettare l'invito, ma se non riuscite a rientrare in questo limite temporale, potete chiedere di farvelo inviare di nuovo.

• Visitate il Catalogo API per stabilire le API giuste per la vostra soluzione. Il vostro FedEx Customer Technology Consultant (CTC) e il Compatible Channel Manager possono aiutarvi a selezionare le API giuste per la soluzione in base alle vostre esigenze aziendali.

• Selezionate un'API per avere una panoramica generale, modificare i registri e le caratteristiche principali.

• Visualizzate la documentazione dell'API per scoprire elementi di richiesta e risposta, esempi nella lingua che preferite, oggetti di errore e altro ancora.

• Tornate a Salesforce per compilare il foglio di lavoro delle informazioni sul prodotto (PIW) ed elencare le API che desiderate aggiungere alla vostra soluzione.

Una volta che il PIW è stato approvato, FedEx creerà i vostri progetti. Ogni versione di ciascuna delle vostre soluzioni avrà un progetto separato all'interno del FedEx Developer Portal. Se un utente non è un amministratore dell'organizzazione, dovrebbe essere invitato a visualizzare ogni progetto. 

Questo è anche il momento in cui il team FedEx Compatible insieme al FedEx CTC e ai team di certificazione organizzeranno una dimostrazione tecnica per le API con il vostro team. Il team FedEx discuterà le nuove caratteristiche e funzionalità disponibili con la versione delle API che state adottando. Il team sarà in grado di rispondere a domande tecniche riguardanti le API, i test delle API e tutti i processi che devono essere completati per avviare il processo di "certificazione *" per le API.

* Certificazione – Il processo definito dal Programma FedEx Compatible per soddisfare i requisiti di conformità del programma. La Certificazione del Programma Compatibile è richiesta per garantire che tutti i Fornitori Compatible implementino, commercializzino e distribuiscano la tecnologia FedEx ai mittenti (clienti) come definito dalla tecnologia e dagli standard di servizio FedEx.

1. Ora avrete accesso alla vostra chiave API di prova e alla chiave segreta di prova per iniziare a eseguire le transazioni. Recuperateli dalla scheda Chiave di prova della pagina Panoramica del progetto.

1. Per creare le chiavi del cliente, dovrete utilizzare l'API registrazione credenziali, che è un'API privata che si trova solo nella sezione API di ciascuno dei vostri progetti.
2. Dopo aver creato alcune chiavi cliente, andate avanti e richiedete un token di accesso OAuth da utilizzare con ogni transazione API. La sessione per il token è valida solo per un'ora, quindi dovrete codificare la vostra applicazione in maniera programmatica per aggiornare il token prima che la sessione scada. Fate riferimento ai documenti dell'Autorizzazione API per maggiori informazioni. Durante la visualizzazione del codice di esempio, assicuratevi che "Rivenditore" sia scelto dal menù a tendina degli esempi.

1. Selezionate i documenti per le API sulla pagina Chiavi test e leggete il contesto commerciale per comprendere meglio come utilizzare l'API selezionata. Riesaminate le richieste d'esempio per il terminale che corrisponde all'integrazione desiderata.
2. Implementate le vostre chiamate verso questi terminali come descritto nelle richieste d'esempio, configurandole per utilizzare le credenziali di prova.
3. Verificate che le risposte ricevute alle chiamate API corrispondano a quelle mostrate nella documentazione.
4. Testate completamente la vostra implementazione all'interno dell'ambiente FedEx utilizzando credenziali e URI di prova FedEx.
5. Dopo aver testato completamente le soluzioni, certificate ciascuna soluzione in Salesforce. FedEx esaminerà completamente tutto ciò che è stato inviato e vi aggiornerà una volta che la vostra certificazione sarà stata approvata.

• FedEx sposterà quindi i vostri progetti in produzione.
• Sarete quindi in grado di vedere la vostra chiave API di produzione nella scheda chiave di produzione della pagina Panoramica del progetto.

• La vostra chiave segreta di produzione dovrà essere generata cliccando sul link Generare chiave segreta nella colonna Chiave segreta.
• È ora possibile ripetere il test della propria implementazione nell'ambiente di produzione utilizzando dati di esempio.
• Approfittate dei vantaggi della nuova integrazione!