CRUD Operations

Per poter eseguire una richiesta HTTP al servizio WebApi e poter testare i parametri da inviare e le risposte ottenute, la cosa più semplice da fare è installare il programma Postman, liberamente scaricabile per tutte le piattaforme o installabile anche come applicazione interna al browser chrome. Gli esempi di seguito riportati si basano su questo programma, anche se di fatto è possibile utilizzare un qualsiasi programma o utility in grado di generare richieste HTTP, come CURL.

Endpoint di riferimento

Le risorse di Enterprise WebAPI sono installate per rispondere all’URL del server nel formato webapi_base_url che è la composizione di quanto indicato nel seguito con server+porta+rootpath.

Gestire l’autenticazione

Per testare il servizio occorre utilizzare il Bearer Token staccato in fase di login.

Dichiarare lo scope

Occorre specificare obbligatoriamente un ulteriore parametro di autenticazione, denominato Authorization-Scope: questo parametro obbligatorio va definito come header aggiuntivo nella richiesta HTTP, ed il valore deve obbligatoriamente corrispondere al valore del parametro “ambiente” specificato nell’URL.

Personalizzare la richiesta

È possibile specificare negli header della richiesta HTTP due ulteriori parametri opzionali, utili per modificare il comportamento standard del servizio:

• Accept: definisce il formato di serializzazione dei parametri in input/output. I valori possibili sono:
  • application/json: i dati ritornati dal servizio (GET: lettura) o accettati in input (POST: creazione o PUT/PATCH: modifica) sono serializzati in formato JSON.
    suggerimento

    Questo è il formato di default, ovvero il formato utilizzato se l’header Accept non viene specificato.

  • application/xml: i dati ritornati dal servizio (GET: lettura) o accettati in input (POST: creazione o PUT/PATCH: modifica) sono serializzati in formato XML.
• Accept-Encoding: se presente e contenente il valore gzip, compress, la risposta HTTP viene compressa in formato GZIP per velocizzare il trasferimento dati.
• Accept-Language: se presente e valorizzato con un codice di lingua IETF (come it, en o en-US tra i molti altri), imposta la lingua del sistema e quindi dei messaggi di errore e/o di validazione.
  suggerimento

  • La lingua di default, ovvero quella impostata se l’header Accept-Language non viene specificato, è l’italiano.
  • La risposta del servizio WebApi contiene gli header Content-Type, Content-Language e Content-Encoding, che possono quindi essere utilizzati per decidere come deserializzare i dati ottenuti.