Documentazione AR APIv2 1.0.8 Help

Details

badge Status-ACTIVE

La chiamata di dettaglio CardReleased permette, indicando il codice univoco della Card, di:

  • Ricevere, nel dettaglio, i parametri relativi alla Card;

  • Ricevere l’elenco di Licenze Softwares attive, eventualmente associate alla Card;

  • Ricevere l’elenco dei Softwares, raggruppati per Software Group, attivabili per la Card specificata (se esistono e non sono già attive le corrispettive Licenze);

Richiede in ingresso:

  • Codice univoco e identificativo della Card;

Restituisce:

  • I parametri della Card;

  • (Opzionale) Lista di Licenze Software attive;

  • (Opzionale) Lista di Softwares, gruppati per Software Group, attivabili;

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

Chiave

Valore

Indirizzo Test

https://test-apiv2.smiletech.it/APIv2/CardReleaseds/Details/{cardCode}

Indirizzo Prod

https://apiv2.smiletech.it/APIv2/CardReleaseds/Details/{cardCode}

Metodo

GET

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-" }

Il codice univoco della Card va inserito come parametro nell’URL andando a sostituire {cardCode} all’interno dell’indirizzo.

In questo caso la struttura body di request non è necessaria e rimane vuota:

Request body

{ }

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

Response body

{ "cardReleased": { "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}", "downloadLink": "[string]{link di download del Software}", "group": "[string]{nome del gruppo Software di appartenenza}", "groupCode": "[string]{codice unvico del gruppo Software di appartenenza}", "dateActived": "[DateTime]{data/momento di attivazione Licenza Software}" } ], "softwaresToActivate": [ { "softwareGroupName": "[string]{nome del Gruppo Software}", "softwareGroupCode": "[string]{codice identificativo del Gruppo Software}", "softwareGroupDescription": "[string]{descrizione del Gruppo Software}", "softwares": [ { "name": "[string]{nome del Software}", "description": "[string]{descrizione del Software}", "platform": "[string]{piattaforma di utilizzo del Software}", "code": "[string]{codice identificativo univoco del Software}", "downloadLink": "[string]{link di download del Software}" } ] } ] }

Un esempio di chiamata con dati verosimili:

https://test-apiv2.smiletech.it/APIv2/CardReleaseds/Details/006D25ADB1454157

Header

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

Request body

{ }

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

Response body

{ "cardReleased": { "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": "Norton 360", "code": "N360", "license": "AAAA1-BBBB2-CCCC3-DDDD4", "downloadLink": "oaservice.it/internetsecurity.exe", "group": "Antivirus", "groupCode": "ANTVIR", "dateActived": "2022-05-26 12:09:56.1290709" } ], "softwaresToActivate": [ { "softwareGroupName": "Antivirus", "softwareGroupCode": "ANTVIR", "softwareGroupDescription": "Antivirus Group", "softwares": [ { "name": "Kaspersky Internet Security", "description": "Internet security, protezione dei pagamenti..", "platform": "PC", "code": "KIS", "downloadLink": "oaservice.it/internetsecurity.exe" } ] } ] }

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

Response

Status: 400 Bad Request

{ "error": "CardReleased non trovata per il codice indicato." }

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