Documentazione AR APIv2 1.0.8 Help

Softwares To Activate

badge Status-ACTIVE

La chiamata di elenco Softwares attivabili per CardReleased permette, indicando il codice univoco della Card, di:

  • Ricevere l’elenco di Softwares attivabili, gruppati per Softwares Group, per la Card indicata (se NON esistono Licenze attive corrispondenti);

  • Ricevere l’elenco di Licenze Softwares già attive (se presenti);

Richiede in ingresso:

  • Codice univoco e identificativo della Card;

Restituisce:

  • L’elenco di Softwares attivabili;

  • L’elenco di Licenze Softwares già attive;

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

Chiave

Valore

Indirizzo Test

https://test-apiv2.smiletech.it/APIv2/Softwares/SoftwaresToActivate/{cardCode}

Indirizzo Prod

https://apiv2.smiletech.it/APIv2/Softwares/SoftwaresToActivate/{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 il 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

{ "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}" } ] }, ], "licensesActived": [ { "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 univoco del gruppo Software di appartenenza}", "dateActived": "[DateTime]{data/momento di attivazione Licenza Software}" } ] }

Un esempio di chiamata con dati verosimili:

https://test-apiv2.smiletech.it/APIv2/Softwares/SoftwaresToActivate/0AA53454BFE041D4

Header

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

Request body

{ }

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

Response body

{ "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" } ] }, ], "licensesActived": [ { "name": "Microsft 365 Personal 12 mesi", "code": "OFF365", "license": "AAAA1-BBBB2-CCCC3-DDDD4", "downloadLink": "oaservice.it/internetsecurity.exe", "group": "Productivity", "groupCode": "PROD", "dateActived": "2023-05-26 12:09:56.1290709" } ] }

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