Differenze tra le versioni di "Generale"

Da CometaSoftware Wiki.
Jump to navigation Jump to search
Riga 16: Riga 16:
  
 
     </p>
 
     </p>
 +
<table id="tblFunzioni" border="0" style="border:1px solid #999; border-collapse:collapse">
 +
            <tr>
 +
                <th>METODO</th>
 +
                <th>HTTP Verb</th>
 +
                <th>PARAMETRI</th>
 +
                <th>RISULTATO</th>
 +
 +
            </tr>
 +
            <tr>
 +
                <td id="login"><b>login</b></td>
 +
                <td>POST, GET</td>
 +
 +
                <td>
 +
                    <b>xx-www-form-urlencoded</b>
 +
                    <table>
 +
                        <tr>
 +
                            <th>parametro</th>
 +
                            <th>descrizione</th>
 +
                            <th>default</th>
 +
                            <th>obbligatorio</th>
 +
                        </tr>
 +
                        <tr>
 +
                            <td><b>username</b></td>
 +
                            <td>nome utente login</td>
 +
                            <td></td>
 +
                            <td>SI</td>
 +
                        </tr>
 +
 +
                        <tr>
 +
                            <td><b>password</b></td>
 +
                            <td>password utente login</td>
 +
                            <td></td>
 +
                            <td>SI</td>
 +
                        </tr>
 +
                        <tr>
 +
                            <td><b>id</b></td>
 +
                            <td>codice Cliente di Cometa</td>
 +
                            <td></td>
 +
                            <td>SI</td>
 +
                        </tr>
 +
                    </table>
 +
                    <br />
 +
                    <b>application/json</b>
 +
                    <pre>
 +
{
 +
"username":"",
 +
"password":"",
 +
"id": ""
 +
}
 +
 +
</pre>
 +
                </td>
 +
                <td>
 +
                    Il metodo ritorna il seguente oggetto JSON:
 +
                    <pre>
 +
{
 +
  "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
 +
    }
 +
  ]
 +
}</pre>
 +
                    <ul>
 +
                        <li><b>token</b>: è il token di autenticazione necessario da passare nell'header delle api che lo richiedono</li>
 +
                        <li><b>passwordDaCambiare</b>: obbligo per l'utente di cambiare la password</li>
 +
                        <li><b>nominativo</b>: Nominativo dell'utente/cliente di cliente collegato</li>
 +
                        <li><b>clienteCometa</b>: nome del cliente dell'istanza di Cometa</li>
 +
                        <li><b>cliente</b>: true se chi si collega è un cliente di cliente Cometa</li>
 +
                        <li><b>utente</b>: true se chi si collega è un utente di cliente Cometa</li>
 +
                        <li><b>permessi</b>: un array di oggetti che rappresentano i permessi associati all'utente collegato</li>
 +
                    </ul>
 +
 +
                </td>
 +
 +
            </tr>
 +
            <tr>
 +
                <td id="loginReset"><b>login/resetPassword</b></td>
 +
                <td>POST, GET</td>
 +
 +
                <td>
 +
                    <p>Invia un mail all'utente con il link da cliccare per resettare la password</p>
 +
                    <b>xx-www-form-urlencoded</b>
 +
                    <table>
 +
                        <tr>
 +
                            <th>parametro</th>
 +
                            <th>descrizione</th>
 +
                            <th>default</th>
 +
                            <th>obbligatorio</th>
 +
                        </tr>
 +
                        <tr>
 +
                            <td><b>username</b></td>
 +
                            <td>nome utente login</td>
 +
                            <td></td>
 +
                            <td>SI</td>
 +
                        </tr>
 +
                        <tr>
 +
                            <td><b>id</b></td>
 +
                            <td>codice Cliente di Cometa</td>
 +
                            <td></td>
 +
                            <td>SI</td>
 +
                        </tr>
 +
                    </table>
 +
                    <br />
 +
                    <b>application/json</b>
 +
                    <pre>
 +
{
 +
"username":"",
 +
"id": ""
 +
}
 +
 +
</pre>
 +
                </td>
 +
                <td>
 +
                    Il metodo ritorna il seguente oggetto JSON:
 +
                    <pre>
 +
{
 +
    "successo": true,
 +
    "messaggio": null
 +
}
 +
</pre>
 +
                    <ul>
 +
                        <li><b>successo</b>: true se il cambio password è andato a buon fine</li>
 +
                        <li><b>messaggio</b>: messaggio di errore nel caso successo sia false</li>
 +
                    </ul>
 +
                </td>
 +
 +
            </tr>
 +
            <tr>
 +
                <td id="checkToken"><b>checkToken</b></td>
 +
                <td>POST, GET</td>
 +
 +
                <td></td>
 +
                <td>
 +
                    Il metodo ritorna il seguente oggetto JSON:
 +
                    <pre>
 +
{
 +
    "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
 +
        }
 +
    ]
 +
}
 +
</pre>
 +
                    <ul><li><b>valido</b>: true se il token è ancora valido</li></ul>
 +
                </td>
 +
 +
            </tr>
 +
 +
            <tr>
 +
                <td id="cambioP"><b>cambioPassword</b></td>
 +
                <td>POST, GET</td>
 +
 +
                <td>
 +
                    <b>xx-www-form-urlencoded</b>
 +
                    <table>
 +
                        <tr>
 +
                            <th>parametro</th>
 +
                            <th>descrizione</th>
 +
                            <th>default</th>
 +
                            <th>obbligatorio</th>
 +
                        </tr>
 +
                        <tr>
 +
                            <td><b>username</b></td>
 +
                            <td>nome utente login</td>
 +
                            <td></td>
 +
                            <td>SI</td>
 +
                        </tr>
 +
                        <tr>
 +
                            <td><b>oldPassword</b></td>
 +
                            <td>password attuale</td>
 +
                            <td></td>
 +
                            <td>SI</td>
 +
                        </tr>
 +
                        <tr>
 +
                            <td><b>password</b></td>
 +
                            <td>nuova password</td>
 +
                            <td></td>
 +
                            <td>SI</td>
 +
                        </tr>
 +
                    </table>
 +
                    <br />
 +
                    <b>application/json</b>
 +
                    <pre>
 +
{
 +
    "username":"",
 +
    "password":"",
 +
    "oldPassword": ""
 +
}
 +
</pre>
 +
 +
                </td>
 +
                <td>
 +
                    Il metodo ritorna il seguente oggetto JSON:
 +
                    <pre>
 +
{
 +
    "successo": true,
 +
    "messaggio": null
 +
}
 +
</pre>
 +
                    <ul>
 +
                        <li><b>successo</b>: true se il cambio password è andato a buon fine</li>
 +
                        <li><b>messaggio</b>: messaggio di errore nel caso successo sia false</li>
 +
                    </ul>
 +
 +
                </td>
 +
 +
            </tr>
 +
 +
            <tr>
 +
                <td id="contratto"><b>contratto</b></td>
 +
                <td>POST, GET</td>
 +
 +
                <td></td>
 +
                <td>
 +
                    Il metodo ritorna il seguente oggetto JSON:
 +
<pre>
 +
{
 +
    "oreGiornaliere": "08:00:00"
 +
}
 +
</pre>
 +
                   
 +
                </td>
 +
 +
            </tr>
 +
            <tr>
 +
                <td id="deleteToken"><b>deleteToken</b></td>
 +
                <td>POST, GET</td>
 +
 +
                <td></td>
 +
                <td>
 +
            true o false
 +
                </td>
 +
 +
            </tr>
 +
        </table>

Versione delle 14:31, 24 mar 2020

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
Estratto da "https://wiki.cometasoftware.net/index.php?title=Generale&oldid=111"