Una guida rapida per l'integrazione
Vogliamo che la tua integrazione venga avviata rapidamente, in modo da permettere a entrambi di aprire nuovi mercati per i nostri clienti comuni.
Di seguito è riportata la pagina Integrazioni di Udemy Business.
Passaggi prerequisiti
- Domanda di partnership presentata e approvata
- Udemy fornisce un ambiente sandbox per Udemy Business
- L'amministratore Udemy invita utenti aggiuntivi
Se manca uno di questi elementi, consulta la (Guida introduttiva) per poterli completare.
Casi di utilizzo dell'integrazione dei partner: se vuoi rivedere i casi d'utilizzo d'insieme supportati da queste fasi di integrazione. In caso contrario, passiamo allo sviluppo.
Passaggi di sviluppo
La nostra buona pratica consigliata è quella di mitigare il rischio tecnico, connettendosi prima a tutte le API di Udemy, per poi iniziare lo sviluppo del software dopo aver confermato il funzionamento di tutti gli endpoint.
- Connettiti all'API Corsi, sposta almeno 10 corsi
- Connettiti all'API Corsi, sposta 1 corso
- Accedi al sito di Udemy Business e iscriviti a un corso, guarda una lezione per almeno 1 minuto (puoi aumentare la velocità di riproduzione)
- Connettiti all'API di reportistica (utente-attività)
- Connettiti all'API di reportistica (utente-corso-attività)
- Connettiti all'API di reportistica (apprendimento-attività-tentativo)
- Accedi al tuo sito Udemy Business e crea un Percorso di apprendimento (documentazione), apri un corso e aggiungilo al percorso di apprendimento appena creato.
- Connettiti all'API del percorso di apprendimento, sposta il percorso di apprendimento che hai creato.
Configurazioni
Se la maggior parte delle API funziona correttamente, puoi passare alle fasi di configurazione.
- La configurazione del Single Sign On (SSO) si effettua direttamente nella pagina Impostazioni di Udemy Business. Per accedere a queste impostazioni è necessario disporre delle credenziali di amministratore. Configura un sistema SSO pronto per l'uso con uno dei nostri numerosi provider. Oppure crea una connessione personalizzata con SAML 2.0. (link alla documentazione SSO)
- Verifica il resto delle impostazioni all'interno di [Udemy Business: Manage: Settings] e personalizzale a tuo piacimento.
Miglioramenti
Percorsi di apprendimento: consente agli utenti di creare un curriculum contenente una grande varietà di risorse di apprendimento, con un inizio e una fine per guidare l'allievo.
- Accedi al tuo sito Udemy Business e crea un Percorso di apprendimento (documentazione), apri un corso e aggiungilo al percorso di apprendimento appena creato.
- Connettiti all'API del percorso di apprendimento; sposta il percorso di apprendimento che hai creato.
- Connettiti all'API di reportistica (learning-path-activity)
Reportistica in tempo reale tramite Webhook
- Configurazione di xAPI: webhook di Udemy per la segnalazione dei progressi e degli eventi di completamento degli studenti (documentazione). Dovrai aggiungere i parametri nella pagina delle impostazioni dell'amministratore di Udemy.
- Una volta completata la configurazione, guarda una breve lezione alla massima velocità di riproduzione e verifica se hai ricevuto i dati dei progressi.
Interrogare o cercare i dati dei corsi: utilizzando l'API GraphQL di Udemy, permettiamo di interrogare il nostro catalogo di corsi, restituendo solo i dati necessari per quel caso d'uso specifico. Inoltre, mettiamo a disposizione un'API di ricerca che filtra i dati inseriti e restituisce i risultati dei corsi pertinenti.
- Ottieni credenziali API GraphQL
- Chiama funzione GraphQL GetAuthToken()
- Usa [authToken] per chiamare l'API del corso
- Chiama l'API CourseSearch
Attenzione: per accedere alla documentazione GraphQL è necessario il login su Udemy Business. L'URL applicabile presenta il sottodominio dell'account Udemy dell'organizzazione seguito da .udemy.com/dev-portal/api-reference/.
Ad esempio:
https://{sottodominio}.udemy.com/dev-portal/api-reference/.
Sviluppo software di base
Con tutte le credenziali Udemy funzionanti, tutte le API collegate e le configurazioni aggiuntive impostate, il rischio tecnico è stato eliminato. La maggior parte dei partner passerà poi alla pianificazione o allo sviluppo. Un modo per iniziare è prendere un elenco di user stories o di casi di utilizzo supportati e mappare le API Udemy necessarie per ogni caso d'uso. Da qui in poi ti auguriamo buona fortuna con il lavoro di ingegneria del software!
Gestione degli errori, eccezioni e buone pratiche
Proteggi il tuo software incorporando la gestione degli errori, delle eccezioni e dei casi limite. Per gestire i problemi informatici imprevisti, abbiamo una serie di consigli in merito alla gestione degli errori.
Buone pratiche per l'utilizzo delle API di Udemy Business
- Registra le risposte di errore restituite dalle API
- Aggiungi una logica di riprova alle chiamate API
- Gestisci i limiti massimi usando le migliori pratiche di page_size
- Implementa altre buone pratiche contenute nel documento
Per ulteriore assistenza, feedback o al completamento della nuova integrazione, contattaci all'indirizzo partnersupport@udemy.com. Non vediamo l'ora di aprire nuovi mercati insieme grazie alla nostra nuova funzionalità reciproca.