Documentazione AR APIv2 1.0.8 Help

Details

badge Status-ACTIVE

La chiamata di Dettaglio Utente permette, indicando i parametri dello stesso, di:

  • Ricevere il dettaglio dell’ User indicato;

Richiede in ingresso:

  • Parametri dell’Utente

Restituisce:

  • Il dettaglio dell’Utente;

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

Chiave

Valore

Indirizzo Test

https://test-apiv2.smiletech.it/APIv2/Users/Details

Indirizzo Prod

https://apiv2.smiletech.it/APIv2/Users/Details

Metodo

PUT

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

{ "name": "[string]{nome dell’Utente}", "surname": "[string]{cognome dell’Utente}", "email": "[string]{email univoca e identificativa 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:

Response body

{ "user": { "id": [long]{identificativo univoco dell’Utente}, "name": "[string]{nome}", "surname": "[string]{cognome}", "email": "[string]{mail univoca dell’Utente}", "phoneNumber": "[string]{numero di telefono/cellulare}", "shopName": "[string]{nome del negozio di appartentenza}", "shopCode": "[string]{codice identificativo del negozio di appartenenza}", "companyName": "[string]{nome del socio di appartenenza}" } }

Un esempio di chiamata con dati verosimili:

https://test-apiv2.smiletech.it/APIv2/Users/Details

Header

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

Request body

{ "name": "Marco", "surname": "Rossi", "email": "marco@mail.it", "phoneNumber": "333133313", "externalId": "110" }

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

Response body

{ "user": { "id": 291119, "name": "Marco", "surname": "Rossi", "email": "marco@mail.it", "phoneNumber": "333444123543", "shopName": "TIE TEAM", "shopCode": "TT", "companyName": "OASERVICE" } }

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

Response

Status: 400 Bad Request

{ "error": "Campi obbligatori non valorizzati." }

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