Formato delle richieste

Le chiamate sono effettuate tramite richieste http (il metodo raccomandato è il POST) con strutture dati che definiscono la funzione e i parametri associati.

Parametri comuni a tutte le chiamate sono:

  • message_type: Identifica la funzione richiesta
  • version: Identifica la versione del back-end. Al momento l’unico valore accettato è 1.0
  • authentication: Dati relativi all’autenticazione, sia dell’utente che dell’accesso alle API, come illustrato nel paragrafo “autenticazione” 

Codifica JSON

{
    "message_type" : <MESSAGE_TYPE>,
    "version" : "1.0",
    "authentication": {
        "interface_code" : <INTERFACE_CODE>,
        "interface_password" : <INTERFACE_PASSWORD>
        "login" : <LOGIN>,
        "token" : <TOKEN>
        "password" : <PASSWORD>
    },
    ...
}

Codifica multipart / form-data

La struttura JSON può essere “appiattita” mappando gli attributi con un '.' tra i vari livelli, ad esempio 
interface_code
nell'esempio precedente diventa
authentication.interface_code

Tenendo questo presente, è possibile fare le chiamate come segue:

Content-type: multipart/form-data, boundary=Aa254x
--Aa254x
content-disposition: form-data; name="message_type"
<MESSAGE_TYPE>
--Aa254x
content-disposition: form-data; name="version"
1.0
--Aa254x
content-disposition: form-data; name="authentication.interface_code"
<INTERFACE_CODE>
--Aa254x
content-disposition: form-data; name="authentication.interface_password"
<INTERFACE_PASSWORD>
--Aa254x
content-disposition: form-data; name="authentication.login"
<LOGIN>
--Aa254x
content-disposition: form-data; name="authentication.token"
<TOKEN>
--Aa254x
content-disposition: form-data; name="authentication.password"
<PASSWORD>   

Codifica "get"

Oppure, se è utilizzato il metodo GET, nella query-string dell’URL:

https://docubank.kpnqwest.it/backend/v1.0/public/script/
?message_type=<MESSAGE_TYPE>
&version=1.0
&authentication.interface_code=<INTERFACE_CODE>
&authentication.interface_password=<INTERFACE_PASSWORD>
&authentication.login=<LOGIN>
&authentication.token=<TOKEN>
&authentication.password=<PASSWORD>

 



Attenzione: le informazioni riportate in questa sezione possono non essere perfettamente allineate con la versione corrente del servizio, in continua evoluzione. Per qualunque informazione specifica, vi preghiamo di contattarci.