Documentazione AR APIv2 1.0.8 Help

Activate Code

badge Status-ACTIVE

La chiamata di attivazione CardReleased permette, indicando il codice univoco della stessa, di:

  • Attivare la Card per l’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:

  • Codice univoco e identificativo della Card;

Restituisce:

  • I parametri relativi alla Card appena attivata, i parametri dell’Utente, le Licenze Softwares nel caso in cui esistano, da attivare o appena attivate;

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

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

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/CardReleaseds/ActivateCode/{cardCode}

Indirizzo Prod

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

Metodo

UT

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.

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

{ "cardReleased": { "cardCode": "[string]{codice univoco Card, necessario per usufruire del servizio}", "email": "[string]{email del cliente a cui è associata la Card}", "dateActived": "[DateTime] {data/momento di attivazione e validità della Card}", "dateExpired": "[DateTime] {data/momento di scadenza della Card}" }, "softwares": [ { "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}", "resultCode": [int]{codice stato operazione di rilascio (200, 400, 500 etc.)}, "resultMessage": "[string]{messaggio esplicativo del risultato dell’operazione di rilascio}" } ] }

Un esempio di chiamata con dati verosimili:

https://test-apiv2.smiletech.it/APIv2/CardReleaseds/ActivateCode/000B448AC749432C

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

{ "cardReleased": { "cardCode": "006D25ADB1454157", "email": "marco@mail.it", "dateActived": "2023-10-26T19:33:06Z", "dateExpired": "2024-10-26T19:33:06Z" }, "softwares": [ { "name": "Kaspersky Internet Security", "code": "KIS", "license": "AAAA1-BB2BB-3CCCC-D4DDD", "downloadLink": "oaservice.it/internetsecurity.exe", "group": "Antivirus", "resultCode": 200, "resultMessage": "Licenza rilasciata." } ] }

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

Response

Status: 500 Internal Server Error

{ "error": "Errore interno." }

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