Documentazione AR APIv2 1.0.8 Help

User Cards Released

badge Status-ACTIVE

La chiamata di elenco CardReleaseds dell’Utente permette, indicando i parametri dell’Utente designato, di:

  • Ricevere l’elenco delle CardReleased associate all’Utente indicato;

  • (Opzionale) Rilasciare le Licenze Software eventualmente associate alla Card;

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

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

Richiede in ingresso:

  • I parametri dell’Utente;

Restituisce:

  • L’elenco delle card associate all’Utente;

  • (Opzionale) Lista di licenze Software rilasciate, o info sullo stato del rilascio (in caso di software multipli o errore);

  • (Opzionale) Link download del Software;

  • 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;

Softwares:

Nel caso in cui siano associati 1 o più Softwares alla Card rilasciata, verrà gestita con la seguente logica il rilascio delle licenze software designate:

  • Software singolo per gruppo software: rilascio immediato della licenza;

  • Software multiplo per gruppo software: notifica che ci indica di effettuare chiamata di selezione software per la Card (chiamata in fase di implementazione);

Chiave

Valore

Indirizzo Test

https://test-apiv2.smiletech.it/APIv2/CardReleaseds/UserCardsReleaseds

Indirizzo Prod

https://apiv2.smiletech.it/APIv2/CardReleaseds/UserCardsReleaseds

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

[ { "cardReleaseds": { "code": "[string]{codice univoco Card}", "serviceCode": "[string] {codice del Servizio}", "serviceName": "[string] {nome del Servizio}", "serviceEAN": "[string] {codice EAN del Servizio}", "dateActived": "[DateTime]{data/momento di attivazione della Card}", "dateExpired": "[DateTime]{data/momento di scadenza della Card}", "cardSerial": "[string] {seriale Card}", "CodeRenewed": "[string] {codice univoco Card padre (se Card rinnovo)}", "dateRenewed": "[DateTime] {data rinnovo (se Card rinnovo)}", "shopName": "[string] {nome del Negozio}", "shopCode": "[string] {codice del negozio}", "companyName": "[string] {nome del socio}" }, "licenses": [ { "name": "[string] {nome del software}", "code": "[string] {codice identificativo del prodotto}", "license": "[string] {licenza di utilizzo, destinata al cliente finale}", "group": "[string] {nome del gruppo software di appartenenza}", "groupCode": "[string] {codice univoco del gruppo Software di appartenenza}", "dateActived": "[DateTime {data/momento di attivazione Licenza Software}]", "downloadLink": "[string] {link di download del Software}" } ], "softwaresToActivate": [ ] } ]

Un esempio di chiamata con dati verosimili:

https://test-apiv2.smiletech.it/APIv2/CardReleaseds/UserCardsReleaseds

Header

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

Request body

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

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

Response body

[ { "cardReleaseds": [ { "code": "006D25ADB1454157", "serviceCode": "SIRTIE12SMART", "serviceName": "SERVIZIO SMART", "serviceEAN": "2000009904413", "dateActived": "2023-07-03T14:22:03.2872412", "dateExpired": "2024-07-03T14:22:03.2872691", "cardSerial": "1234567ABCD", "codeRenewed": null, "dateRenewed": null, "shopName": "UDINE", "shopCode": "UD", "companyName": "EURONICS" } ], "licenses": [ { "name": "Kaspersky Standard PC", "code": "KS", "license": "AAAA3-BBBB5-CCCC6-53290", "downloadLink": "oaservice.it/internetsecurity.exe", "group": "Antivirus", "groupCode": "ANTVIR", "dateActived": "2024-07-16T15:59:14.9836948", "downloadLink": "www.kaspersky.it/lp/pro-download" } ], "softwaresToActivate": [ ] } ]

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

Response

Status: 400 Bad Request

{ "error": "Utente non trovato per la mail specificata." }

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