Istruzioni tecniche per la fase di test del sistema
Il responsabile dell’IR potrà testare il corretto funzionamento dell’installazione di prova del repository software, integrato con il plug-in NBN, utilizzando le credenziali di accesso specifiche per al Registro Centrale NBN (fornite contestualmente all’installazione del plug-in NBN).
Gli identificativi generati a seguito dei POST di test non potranno essere risolti dal resolver NBN e lo spazio che essi occupano sarà periodicamente svuotato.
Sicurezza
Le richieste al servizio possono essere eseguite solo a seguito di autenticazione, utilizzando i relativi paramenti di accesso, mediante Authentication Digest.
Endpoint
L’API è implementata in RESTful style e l’end point utilizzato è:
http://nbn.depositolegale.it
Accesso al servizio per la fase di test:
URI: http://nbn.depositolegale.it/test/nbn_generator.pl
accetta richiesta con metodo HTTP POST.
Content Type
Per il metodo POST è richiesto un header addizionale, il quale specifichi la comunicazione di parametri in formato JSON
Content-Type:application/json; charset:UTF-8
Request headers
Content-Type:application-json
Request body
– Parametri obbligatori:
action=nbn_create
url={url}
dove {url} deve essere sostituita con la URL puntatore alla rappresentazione della risorsa presente nel repository.
– Parametri opzionali:
metadataurl={metadataurl}
dove {metadataurl} deve essere sostituita con la URL puntatore ai metadati descrittivi della risorsa presenti nel repository.
Response headers
Content-Type:application-json
Response body
Se la richiesta è andata a buon fine, viene restituita una stringa JSON contenente breve spiegazione dello status code ( es. created, url already exists.. ) ed identificativo NBN (indicato nella tabella di seguito nel campo {nbn} ).
Nel caso in cui la richiesta avvenga per una nuova risorsa il response header status avrà valore “201 created”.
Response header status | Response JSON body parameters |
201 created | status = 201, nbn created nbn = {nbn} |
Nell’eventualità in cui la URL per la quale è stato richiesto l’identificativo sia già presente all’interno del Registro Centrale, verrà restituito l’NBN già associato.
Il response header status avrà valore “201 OK”.
Tale procedura è ottimizzata per gestire eventuali riallineamenti delle informazioni all’interno degli IR.
Response header status | Response JSON body parameters |
201 OK | status = 201, url aligned nbn = {nbn} |