Activate Code
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) |
Di seguito la struttura dell’Header contenente:
Header
Il codice univoco della Card va inserito come parametro nell’URL andando a sostituire {cardCode} all’interno dell’indirizzo.
Request body
Di seguito la struttura della response contenente i valori di ritorno dal sistema:
Response body
Un esempio di chiamata con dati verosimili:
https://test-apiv2.smiletech.it/APIv2/CardReleaseds/ActivateCode/000B448AC749432C
Header
Request body
In caso di Successo il sistema ritorna il seguente modello JSON:
Response body
In caso di Errore il sistema ritorna il seguente modello JSON:
Response
Status: 500 Internal Server Error
Errori Riscontrabili
Di seguito la lista che indica gli errori che possono essere riscontrati:
Codice | Descrizione |
|---|---|
400 | I dati in ingresso non sono corretti o non sono correttamente formattati. Viene restituita la descrizione dell’errore nel dettaglio. |
401 | Il codice Token fornito non è valido. L’autenticazione non è andata a buon fine. |
500 | Il server ha riscontrato un errore inaspettato, generalmente esula dal tipo di request e si verifica per problemi assoggettabili al sistema. |