Passo 1: Ottenere un token JWT Prima di effettuare qualsiasi operazione tramite le API di Sisvaldidat, è necessario ottenere un token JWT valido. Il token JWT deve contenere il parametro apiKey, che rappresenta la chiave di accesso fornita nella sezione "Amministrazione -> Api Key", e il parametro ateneoKey, che rappresenta l'identificatore dell'ateneo per cui si desidera effettuare l'operazione. Assicurarsi che il token JWT sia incluso come parametro JSON nel payload della richiesta e come parametro di tutte le richieste successive.

Passo 2: Formulare la richiesta Per verificare la correttezza dei parametri e visualizzare le informazioni sulla tua richiesta, utilizza il metodo HTTP POST all'endpoint specifico: https://sisvaldidat.it/API/4/RequestJob. La richiesta deve includere i seguenti parametri obbligatori nel payload JSON:

• apiKey: Una stringa che rappresenta la chiave di accesso.
• ateneoKey: Un numero intero che identifica l'ateneo desiderato.
• strutturaKey: Chiave del tipo di importazione che si vuole effettuare
• azione: valori accettati add, delete e status

• Parametro azione valore add:
  • CREATE: Indica che il job è stato creato e attende l'acquisizione dei dati.
  • EXISTS: Segnala che il job è già attivo e in attesa di ulteriori dati.
  • ERROR: Indica che il job non è stato creato con successo.

• Parametro azione valore info:
  • EXISTS: Il job è attivo e in attesa di dati.
  • ERROR: Il job non è stato creato correttamente.

• Parametro azione valore delete::
  • DELETE: Indica che il job è stato eliminato con successo.
  • Condizione: Il job può essere eliminato solamente quando si trova nello stato di attesa dei dati. Non è possibile eliminare il job una volta che l'importazione è terminata.

Si prega di notare che:

• Il parametro azione restituisce diverse risposte a seconda dello stato del job al momento della richiesta.
• Con il paramentro azione impostato con valore info consente di verificare lo stato corrente del job, fornendo informazioni se è attivo o se vi sono problemi di creazione.
• Con il paramentro azione impostato con valore delete è disponibile solo quando il job si trova nello stato di "attesa dei dati". Una volta completata l'importazione, questa opzione non è più disponibile per l'eliminazione del job.

Passo 3: Eseguire la richiesta Invia la richiesta al server utilizzando il metodo HTTP POST e l'endpoint specificato. Assicurati di includere il token JWT come parametro JSON nel payload della richiesta.

Passo 4: Elaborare la risposta La risposta restituita sarà un oggetto JSON contenente informazioni sulla correttezza dei tuoi parametri e sulle richieste rimanenti. Puoi elaborare la risposta come desiderato nella tua applicazione per verificare i dettagli e l'avanzamento delle tue richieste.

Ricorda di gestire eventuali errori durante il processo di utilizzo delle API di Sisvaldidat. L'esempio di richiesta generica contiene una lista dei codici di errore comuni a tutte le richieste, mentre eventuali altri errori specifici relativi a una funzione particolare saranno descritti nella documentazione specifica della funzione stessa.