Generale

Le REST API di Cometa mettono a disposizione diverse funzionalità

Il token di autenticazione viene restituito dal metodo di login ed ha una sua validità temporale.
Il token deve essere passato generalmente nell'header della richiesta col nome: "token". E' richiesto per tutti i metodi eccetto login
Alternativamente il token può essere passato anche come parametro "token" nell'url della richiesta, utile quando non si può passare nessun header alla richiesta.
Si può verificare la validità del token con il metodo checktoken.
Se il token è scaduto occorre recuperarne un'altro semplicemente effettuando il login.

Metodi presenti un questa sezione:

• login metodo per effettuare l'autenticazione
• checkToken metodo per verificare la validità del token

METODO	HTTP Verb	PARAMETRI	RISULTATO
login	POST, GET	xx-www-form-urlencoded parametro descrizione default obbligatorio username nome utente login SI password password utente login SI id codice Cliente di Cometa SI application/json { "username":"", "password":"", "id": "" }	Il metodo ritorna il seguente oggetto JSON: { "token": "541bee22-edf2-4c04-98a1-66222b55d759", "passwordDaCambiare": false, "nominativo": "ACCENTURE", "clienteCometa": "OCN", "cliente": true, "utente": false, "capoProgetto": true, "responsabileDiStruttura": true, "approvatoreGiustificativi": true, "moduliAbilitati": [ "TASKS" ], "permessi": [ { "nome": "Cometa Cliente", "descrizione": "Accesso come Cliente", "inserimento": true, "lettura": true, "modifica": true, "eliminazione": true, "esecuzione": true } ] } token: è il token di autenticazione necessario da passare nell'header delle api che lo richiedono passwordDaCambiare: obbligo per l'utente di cambiare la password nominativo: Nominativo dell'utente/cliente di cliente collegato clienteCometa: nome del cliente dell'istanza di Cometa cliente: true se chi si collega è un cliente di cliente Cometa utente: true se chi si collega è un utente di cliente Cometa permessi: un array di oggetti che rappresentano i permessi associati all'utente collegato
login/resetPassword	POST, GET	Invia un mail all'utente con il link da cliccare per resettare la password xx-www-form-urlencoded parametro descrizione default obbligatorio username nome utente login SI id codice Cliente di Cometa SI application/json { "username":"", "id": "" }	Il metodo ritorna il seguente oggetto JSON: { "successo": true, "messaggio": null } successo: true se il cambio password è andato a buon fine messaggio: messaggio di errore nel caso successo sia false
checkToken	POST, GET		Il metodo ritorna il seguente oggetto JSON: { "valido": true, "nominativo": "Parenti Emanuele", "clienteCometa": "OCN", "cliente": false, "utente": false, "capoProgetto": true, "responsabileDiStruttura": true, "approvatoreGiustificativi": true, "moduliAbilitati": [ "TASKS" ], "permessi": [ { "nome": "Documenti", "descrizione": "", "inserimento": true, "lettura": true, "modifica": true, "eliminazione": true, "esecuzione": true }, { "nome": "Giustificativi", "descrizione": "", "inserimento": false, "lettura": false, "modifica": false, "eliminazione": false, "esecuzione": true }, { "nome": "Inserimento ore", "descrizione": "", "inserimento": true, "lettura": true, "modifica": true, "eliminazione": true, "esecuzione": true }, { "nome": "Rubrica", "descrizione": "", "inserimento": false, "lettura": false, "modifica": false, "eliminazione": false, "esecuzione": false } ] } valido: true se il token è ancora valido
cambioPassword	POST, GET	xx-www-form-urlencoded parametro descrizione default obbligatorio username nome utente login SI oldPassword password attuale SI password nuova password SI application/json { "username":"", "password":"", "oldPassword": "" }	Il metodo ritorna il seguente oggetto JSON: { "successo": true, "messaggio": null } successo: true se il cambio password è andato a buon fine messaggio: messaggio di errore nel caso successo sia false
contratto	POST, GET		Il metodo ritorna il seguente oggetto JSON: { "oreGiornaliere": "08:00:00" }
deleteToken	POST, GET		true o false