Vai al contenuto principale

Integrazione API - Panoramica

  Come funziona Se la tua organizzazione dispone di un team di sviluppo affidabile e prevede di integrare Voxy negli strumenti e nei fluss...

Aggiornato oltre 3 mesi fa

Come funziona

Se la tua organizzazione dispone di un team di sviluppo affidabile e prevede di integrare Voxy negli strumenti e nei flussi di lavoro esistenti per amministratori o studenti, allora il Partner API offre opzioni per gestire facilmente gli utenti e visualizzare i dati sulle prestazioni. Il Partner API è uno strumento self-service che le organizzazioni possono utilizzare per progettare, sviluppare e mantenere i propri flussi di lavoro personalizzati. Puoi vedere tutti gli endpoint disponibili qui nella documentazione del Partner API.

Alcuni dei più frequentemente utilizzati includono:

  • Registrazione di un nuovo utente

  • Recupero dei dati di valutazione dell'utente

  • Elenco delle attività completate dall'utente

  • Recupero del tempo dell'utente su un compito entro un determinato intervallo di date

It usually takes just a few days to get your team started. Here’s how it will work:

1. Collabora con il tuo team tecnico per esaminare la documentazione dell'API del partner e preparare un piano di implementazione di base.
2. Condividi il tuo piano con il tuo Manager Voxy. Possono pianificare una consulenza tecnica più approfondita per te, se necessario.
3. Voxy condividerà la chiave API e il segreto dell'organizzazione e fornirà l'accesso al nostro repository GitHub di esempi di codice in vari linguaggi di programmazione.
4. Il tuo team completerà lo sviluppo in base al tuo caso d'uso personalizzato.
5. Raccomandiamo vivamente di effettuare test completi end-to-end prima di lanciare un nuovo programma con un'integrazione API o prima di rilasciare importanti aggiornamenti dell'API in produzione. Se non sei sicuro di cosa testare, contatta il tuo Manager Voxy o il Supporto Partner Voxy.

Note di implementazione

Gestione degli utenti

Le nostre integrazioni API più riuscite vengono utilizzate per automatizzare la creazione degli utenti e gli aggiornamenti dell'account. Questo funziona meglio se i tuoi studenti scopriranno Voxy all'interno di un LMS o portale esistente e utilizzeranno un flusso che tu stesso progetterai per l'auto-iscrizione.

Puoi facilmente utilizzare l'API del Partner per creare utenti, bloccare l'accesso (ad esempio, scadere gli utenti), spostarli tra gruppi di funzionalità con diversi diritti. Dovrai contattare il Supporto Partner di Voxy per creare o aggiornare i diritti dei gruppi di funzionalità.

La gestione degli utenti tramite API è compatibile con diversi metodi di autenticazione (vedi Panoramica dell'Integrazione dell'Autenticazione). Se stai anche considerando SSO con SAML o OIDC, ti consigliamo di utilizzare la creazione degli utenti just-in-time per creare account.

Report e Dashboard

Se sei interessato a utilizzare la Partner API per configurare report personalizzati o dashboard, ti incoraggiamo vivamente a esaminare attentamente i documenti della Partner API per garantire che i dati disponibili soddisfino le tue esigenze. Sebbene Voxy rimanga impegnata nella funzionalità continua dei punti finali API esistenti e nell'integrità dei dati restituiti, aggiungiamo nuove funzionalità e report al Voxy Command Center più frequentemente rispetto alla Partner API.

Supporto Continuo

Voxy può fornire una consulenza iniziale e supporto all'avvio, ma abbiamo risorse limitate per assistere nella progettazione e nello sviluppo di applicazioni personalizzate per i clienti. Se il tuo team non dispone di un team dedicato per sviluppare e mantenere i flussi di lavoro personalizzati, ti consigliamo vivamente di utilizzare il Voxy Command Center per la gestione degli utenti e la segnalazione.

Se incontri problemi con un'integrazione esistente, puoi contattare il supporto partner di Voxy con la tua richiesta. Per la maggior parte delle richieste di supporto, ti chiederemo le seguenti informazioni prima di poterle far pervenire a un esperto tecnico:

  • Una panoramica del comportamento atteso e osservato

  • Richiesta completa e risposta con intestazioni e autorizzazione

  • Identificatori per eventuali utenti specifici (se applicabile)

Pronto per Iniziare?

Se hai domande generali, puoi contattare il supporto partner di Voxy. Se sei pronto per iniziare, contatta oggi il tuo Manager Voxy!

Cerchi SSO?

Se sei interessato a un'integrazione di accesso singolo (SSO), ti preghiamo di consultare la nostra Panoramica dell'Integrazione dell'Autenticazione.

Hai ricevuto la risposta alla tua domanda?