Documentazione AR APIv2 1.0.8 Help

Send Support Request

badge Status-ACTIVE

La chiamata di Invio Richiesta di Supporto permette, indicandone i parametri relativi, di:

  • Aprire una Richiesta di Supporto (Ticket), per la Card indicata;

  • (Opzionale) Creare o aggiornare l’Utente indicato;

    • Allineare DB del socio, se viene indicato l’Identificativo esterno dell’utenza;

Richiede in ingresso:

  • I parametri relativi alla Richiesta di Supporto;

  • Parametri dell’Utente

Restituisce:

  • Il Ticket appena aperto;

  • Oppure, se non va a buon fine, la descrizione dell’errore riscontrato;

Utente esterno:

Nel caso in cui venga specificato un identificativo esterno Utente, per allineamento con base dati del socio, verrà gestita con la seguente logica la creazione/aggiornamento dell’Utente:

  • Corrispondenza Id trovata: aggiornamento eventuale dati (email, telefono, etc.);

  • Corrispondenza Id non trovata, corrispondenza mail trovata: viene associato l’identificativo esterno all’Utenza, per la mail indicata, e successivamente vengono aggiornati i dati Utente;

  • Nessuna corrispondenza trovata: viene creato un nuovo Utente con tutti i dati specificati;

  • Id esterno non specificato: nessun allineamento dati, ricerca utenza per email;

Chiave

Valore

Indirizzo Test

https://test-apiv2.smiletech.it/APIv2/Supports/SendSupportRequest

Indirizzo Prod

https://apiv2.smiletech.it/APIv2/Supports/SendSupportRequest

Metodo

POST

Success Response

200 (Success)

Error Response

400 (Bad Request)
401 (Unauthorized)
500(Internal Server Error)

Di seguito la struttura dell’Header contenente:

Header

{ "authorization": "Bearer -indicare-qui-Token-fornito-" }

Di seguito la struttura del body contenente i valori da inserire all’interno della richiesta:

Request body

{ "codeCardReleased": "[string]{codice univoco della CardReleased} OBBLIGATORIO", "idQuestionSelected": [long]{identificativo univoco della Domanda selezionata} OBBLIGATORIO, "problemDescription": "[string]{descrizione della problematica riscontrata dall’Utente}", "user": { "name": "[string]{nome dell’utente}", "surname": "[string]{cognome dell’utente}", "email": "[string]{mail univoca dell’Utente}", "phoneNumber": "[string]{numero di telefono dell’Utente}", "externalId": "[string][opzionale]{identificativo esterno dell’Utente}" } }

Di seguito la struttura della response contenente i valori di ritorno dal sistema:

{ "ticket": { "id": [long]{identificativo univoco del Ticket}, "cardCode": "[string]{codice univoco della CardReleased di appartenenza}", "dateOpened": "[DateTime]{data di apertura del Ticket}", "dateAppointment": "[DateTime]{data appuntamento risoluzione, concordato con il cliente}", "dateClosed": "[DateTime]{data di risoluzione del Ticket}", "dateReplied": "[DateTime]{data di risposta da parte dell’operatore, al Ticket}", "title": "[string]{titolo della problematica riscontrata}", "problemDescription": "[string]{descrizione accurata della problematica riscontrata}", "replySolution": "[string]{risposta di risoluzione dell’operatore}", "feedback": "[string]{resoconto dell’esperienza dell’utente}", "feedbackValue": [int][nullable]{valutazione (da 1 a 5) dell’esperienza dell’utente}, "isTaken": [bool]{indica se il Ticket è stato preso in carico dall’Operatore}, "hasAppointment": [bool]{indica se il Ticket ha un appuntamento di risoluzione fissato}, "isClosed": [bool]{indica se il Ticket è chiuso (true) o aperto (false)}, "isResolved": [bool]{indica se il Ticket è risolto (true) o meno (false)} } }

Un esempio di chiamata con dati verosimili:

https://test-apiv2.smiletech.it/APIv2/Supports/SendSupportRequest

Header

{ "authorization": "Bearer NTNv7j0TuYARvmNMmWXo6fKvM4o6nv/aUi9ryX38ZH+L1bkrnD1ObOQ8Jdav" }

Request body

{ "codeCardReleased": "003E5E25E4484094", "idQuestionSelected": 7, "questions": null, "problemDescription": "Non riesco ad avviare i programmi, il PC è troppo lento.", "user": { "name": "Marco", "surname": "Rossi", "email": "m.rossitobia@gmail.com", "phoneNumber": "39275452", "externalId": "1114" } }

In caso di Successo il sistema ritorna il seguente modello JSON:

Response body

{ "ticket": { "id": 46789, "cardCode": "003E5E25E4484094", "dateOpened": "2023-06-30T17:45:59.0300711", "dateAppointment": "2023-07-01T12:30:59.0300711", "dateClosed": null, "dateReplied": null, "title": "Il computer è lento e ci impiega tanto a caricare", "problemDescription": "Non riesco ad avviare i programmi, il PC è troppo lento.", "replySolution": null, "feedback": null, "feedbackValue": null, "isTaken": true, "hasAppointment": true, "isClosed": false, "isResolved": false } }

In caso di Errore il sistema ritorna il seguente modello JSON:

Response

Status: 400 Bad Request

{ "error": "CardReleased non trovata." }

Errori Riscontrabili

Di seguito la lista che indica gli errori che possono essere riscontrati:

Codice

Descrizione

400
(BadRequest)

I dati in ingresso non sono corretti o non sono correttamente formattati. Viene restituita la descrizione dell’errore nel dettaglio.

401
(Unauthorized)

Il codice Token fornito non è valido. L’autenticazione non è andata a buon fine.

500
(Internal Server Error)

Il server ha riscontrato un errore inaspettato, generalmente esula dal tipo di request e si verifica per problemi assoggettabili al sistema.

17 novembre 2025