Formeeting - Web API

STANDARD LIST:

1. Lista dei corsi/eventi
2. Lista degli utenti iscritti ad un corso
3. Lista degli utenti che hanno terminato un corso
4. Creare un nuovo corso
5. Ottenere la lista dei corsi ai quali è iscritto un utente
6. Verificare se un utente ha terminato un corso
7. Creare un nuovo utente
8. Modificare/aggiornare un utente
9. Inviare Codici di accesso ad un utente
10. Rimuovere un utente
11. Single Sign-On (SSO)

[API Web vers. 2]

Di seguito vengono riportate le indicazioni per poter "manipolare" gli utenti/corsisti tramite API_KEY.
La propria API_KEY è individuabile alla sezione "Impostazioni" dell'Area Riservata accessibile agli utenti di tipo "Segreteria" di Formeeting. In caso di necessità o ulteriori informazioni utilizzare il nostro Servizio di Supporto

Ottenere la lista dei corsi/eventi:

ENDPOINT: https://www.formeeting.it/apiweb_v2/listofcourses.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY

ESEMPIO DI CHIAMATA:

<script type="text/javascript">
$(document).ready(function() {
  $("#pulsante").click(function(){
    var apikey = "{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}";
    $.post("https://www.formeeting.it/apiweb_v2/listofcourses.fmp", { apikey: apikey }, function(msg){ $("#risultato").html(msg); });
    })})
	</script>

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}</Apikey>
<Result>1</Result>
<ListaCorsi>
<Corso>
<Codice_corso>9346</Codice_corso>
<Titolo>Come creare immagini veloci con Canva</Titolo>
<DataCreazione>22/09/2019</DataCreazione>
<Stato>ON</Stato>
<ValidoDal>20/05/2018</ValidoDal>
<ValidoFino>31/12/2025</ValidoFino>
</Corso>
<Corso>
<Codice_corso>3267</Codice_corso>
<Titolo>Come Sviluppare e pubblicare una strategia di Facebook che Funzioni</Titolo>
<DataCreazione>30/01/2019</DataCreazione>
<Stato>ON</Stato>
<ValidoDal>20/05/2018</ValidoDal>
<ValidoFino>31/12/2025</ValidoFino>
</Corso>
</ListaCorsi>
</output>

Ottenere la lista degli utenti iscritti ad un corso/evento:

ENDPOINT: https://www.formeeting.it/apiweb_v2/listofusers.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
codice_corso=CODICE IDENTIFICATIVO DEL CORSO

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}</Apikey>
<Result>1</Result>
<ListaUtenti>
<Utente>
<Codice_utente>699427</Codice_utente>
<UserID>mariorossi</UserID>
<Nome>Mario</Nome>
<Cognome>Rossi</Cognome>
<Email>mario.rossi@gmail.com</Email>
<Telefono>3456387265<Telefono/>
<Stato>1</Stato>
<TipoUtente>Allievo</TipoUtente>
<AttivoDal>05/04/2020</AttivoDal>
<AttivoFinoAl>31/12/2025</AttivoFinoAl>
</Utente>
<Utente>
<Codice_utente>710428</Codice_utente>
<UserID>carlobianchi89</UserID>
<Nome>Carlo</Nome>
<Cognome>Bianchi</Cognome>
<Email>cbianchi89@gmail.com</Email>
<Telefono>3516387223<Telefono/>
<Stato>1</Stato>
<TipoUtente>Tutor</TipoUtente>
<AttivoDal>30/04/2020</AttivoDal>
<AttivoFinoAl>28/04/2030</AttivoFinoAl>
</Utente>
</ListaUtenti>
</output>

NEW Ottenere la lista degli utenti che hanno terminato un corso/evento:

ENDPOINT: https://www.formeeting.it/apiweb_v2/listofendusers.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
codice_corso=CODICE IDENTIFICATIVO DEL CORSO

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}</Apikey>
<Result>1</Result>
<ListaUtenti>
<Utente>
<Codice_utente>699427</Codice_utente>
<Nome>Mario</Nome>
<Cognome>Rossi</Cognome>
<TipoUtente>P</TipoUtente>
<Superamento>1</Superamento>
<DataSuperamentoTestFinale>19/2/2023</DataSuperamentoTestFinale>
<PunteggioTest>87,33%</PunteggioTest>
<Crediti>50</Crediti>
</Utente>
<Utente>
<Codice_utente>710428</Codice_utente>
<Nome>Carlo</Nome>
<Cognome>Bianchi</Cognome>
<TipoUtente>P</TipoUtente>
<Superamento>1</Superamento>
<DataSuperamentoTestFinale>9/2/2023</DataSuperamentoTestFinale>
<PunteggioTest>88,67%</PunteggioTest>
<Crediti>50</Crediti>
</Utente>
</ListaUtenti>
</output>

Creare un nuovo corso/evento:

ENDPOINT: https://www.formeeting.it/apiweb_v2/addevent.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
titolo_evento=TITOLO DEL CORSO/EVENTO
tipo_evento=TIPOLOGIA DI EVENTO (0 ONLINE - 1 RESIDENZIALE - 2 LIVE - 3 IBRIDO)
data_inizio=DATA DI INIZIO (dd/mm/aaaa)
data_fine=DATA DI FINE (dd/mm/aaaa)
live=0 oppure 1 (se valore uguale a 1 verrà reso visibile il pulsante LIVE agli utenti)
stato=0 oppure 1 (se valore uguale a 0 il corso/evento viene impostato come disabilitato)

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}</Apikey>
<Result>1</Result>
<Codice_corso>9346</Codice_corso>
<Live>1</Live>
<Stato>1</Stato>
</output>

Ottenere la lista dei corsi/eventi ai quali è iscritto un utente:

ENDPOINT: https://www.formeeting.it/apiweb_v2/listofcoursesforuser.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
userid=USERID UTENTE
pwd=PASSWORD UTENTE

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}</Apikey>
<Result>1</Result>
<UserId>carlobianchi</UserId>
<ListaCorsi>
<Corso>
<Ente>Virtual+Meeting</Ente>
<Codice_corso>2673</Codice_corso>
<Titolo>PHOTOSHOP+CS6+AVANZATO</Titolo>
<Scadenza>31/12/2025</Scadenza>
<url>https://www.formeeting.it/fad/st_cambia_corso.fmp?id=79234</url>
</Corso>
<Corso>
<Ente>Virtual+Meeting</Ente>
<Codice_corso>2670</Codice_corso>
<Titolo>MICROSOFT+OFFICE+365+LIVELLO+BASE</Titolo>
<Scadenza>15/10/2019</Scadenza>
<url>https://www.formeeting.it/fad/st_cambia_corso.fmp?id=11879</url>
</Corso>
</ListaCorsi>
</output>

NEW Verificare se un utente ha terminato il corso/evento:

ENDPOINT: https://www.formeeting.it/apiweb_v2/checkenduser.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
userid=USERID UTENTE
codice_corso=CODICE IDENTIFICATIVO DEL CORSO

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}</Apikey>
<Result>1</Result>
<Codice_corso>5478</Codice_corso>
<Codice_utente>710428</Codice_utente>
<Nome>Carlo</Nome>
<Cognome>Bianchi</Cognome>
<TipoUtente>P</TipoUtente>
<Superamento>1</Superamento>
<DataSuperamentoTestFinale>9/2/2023</DataSuperamentoTestFinale>
<PunteggioTest>88,67%</PunteggioTest>
<Crediti>50</Crediti>
</output>

Creare un nuovo utente:

ENDPOINT: https://www.formeeting.it/apiweb_v2/adduser.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
codice_corso=CODICE IDENTIFICATIVO DEL CORSO
nome=NOME CORSISTA
cognome=COGNOME CORSISTA
mail=EMAIL CORSISTA

PARAMETRI FACOLTATIVI:
get_code=0 oppure 1 (se valore uguale a 1 vengono aggiunti alla risposta userid e password dell'utente creato)
stato=0 oppure 1 (se valore uguale a 0 l'utente viene impostato come disabilitato)
tel=TELEFONO
codfisc=CODICE FISCALE
piva=PARTITA IVA
indirizzo=INDIRIZZO
citta=CITTA'
cap=CAP
provincia=PROVINCIA
luogonascita=LUOGO DI NASCITA
datanascita=DATA DI NASCITA (dd/mm/aaaa)
professione=PROFESSIONE
specializzazione=SPECIALIZZAZIONE/DISCIPLINA

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}</Apikey>
<Result>1</Result>
<Codice_utente>615958</Codice_utente>
<UserId>Null</UserId>
<Pwd>Null</Pwd>
</output>

Modificare/aggiornare un utente:

ENDPOINT: https://www.formeeting.it/apiweb_v2/updateuser.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
userid=USERID UTENTE
codice_utente=CODICE IDENTIFICATIVO UTENTE

PARAMETRI FACOLTATIVI:
nome=NOME
cognome=COGNOME
mail=EMAIL
stato=0 oppure 1
tel=TELEFONO
codfisc=CODICE FISCALE
piva=PARTITA IVA
indirizzo=INDIRIZZO
citta=CITTA'
cap=CAP
provincia=PROVINCIA
luogonascita=LUOGO DI NASCITA
datanascita=DATA DI NASCITA (dd/mm/aaaa)
professione=PROFESSIONE
specializzazione=SPECIALIZZAZIONE/DISCIPLINA

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEZX72C54}</Apikey>
<Result>1</Result>
<Codice_utente>641962</Codice_utente>
<UserId>carlobianchi89</UserId>
</output>

Inviare le credenziali di accesso ad un utente:

ENDPOINT: https://www.formeeting.it/apiweb_v2/sendcredentials.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
userid=USERID UTENTE
codice_utente=CODICE IDENTIFICATIVO UTENTE

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEBA79C24}</Apikey>
<Result>1</Result>
<Codice_utente>641962</Codice_utente>
<UserId>carlobianchi89</UserId>
</output>

Rimuovere un utente:

ENDPOINT: https://www.formeeting.it/apiweb_v2/deluser.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
userid=USERID UTENTE
codice_utente=CODICE IDENTIFICATIVO UTENTE

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEBA79C24}</Apikey>
<Result>1</Result>
<Codice_utente>641962</Codice_utente>
<UserId>carlobianchi89</UserId>
</output>

Funzionalità di Single Sign-On (SSO):

E' possibile eseguire una chiamata POST all'indirizzo di seguito indicato per poter loggare un utente alla piattaforma VM eLearning. Questa operazione risulta essere particolarmente utile qualora si intenda autenticare l'utente su una propria piattaforma/area riservata e contestualmente loggarlo anche su VM. Dopo l'autenticazione l'utente potra infatti, secondo le modalità da voi ritenute più opportune, accedere ai propri corsi online senza doversi nuovamente autenticare.

ENDPOINT: https://www.formeeting.it/apiweb_v2/sso.fmp
METODO: POST

PARAMETRI OBBLIGATORI:
apikey=YOUR_API_KEY
userid=USERID UTENTE
pwd=PASSWORD UTENTE

LEGENDA OUTPUT:
RESULT: (0 in caso di esito negativo - 1 in caso di esito positivo)
CODE: (0: ApiKey errata - 1: dati mancanti - 2: dati errati - 3: utente inesistente - 4: cliente scaduto - 5: corso non attivo - 6: utente abilitato)
URL: pagina web verso cui reindirizzare l'utente per iniziare il corso/i

L'utente sarà pertanto loggato su VM se la risposta alla chiamata restituirà result=1 e code=6.

ESEMPIO DI RISPOSTA:

<output>
<Apikey>{DBEBF4E7-EED5-4AB4-889A-4E4BEBA79C24}</Apikey>
<Result>1</Result>
<Code>6</Code>
<UserId>carlobianchi89</UserId>
<url><![CDATA[ https://www.formeeting.it/fad/login.fmp?token=fgeEgugregerioiger2ZaZu1098Klmnd&stats=yes&ui=default&ud=carlobianchi89&view=response&fit=yes&ckd=terg5tergerg&pwd=3161&own=VM&date=01/02/2022&pwds=bugu4gui3giub432&utm=webapi ]]></url>
</output>

Nel caso abbiate necessità di ulteriori e differenti "modi" di integrazione con la piattaforma, il nostro Ufficio Tecnico è a vostra completa disposizione per analizzare qualsiasi richiesta!

E-Learning / Integrazione & Web API

STANDARD LIST:

[API Web vers. 2]

Ottenere la lista dei corsi/eventi:

Ottenere la lista degli utenti iscritti ad un corso/evento:

NEW Ottenere la lista degli utenti che hanno terminato un corso/evento:

Creare un nuovo corso/evento:

Ottenere la lista dei corsi/eventi ai quali è iscritto un utente:

NEW Verificare se un utente ha terminato il corso/evento:

Creare un nuovo utente:

Modificare/aggiornare un utente:

Inviare le credenziali di accesso ad un utente:

Rimuovere un utente:

Funzionalità di Single Sign-On (SSO):