Subscription *
La chiamata di Subscription permette, indicando i parametri della card e dell'utente di creare o aggiornare un abbonamento e il relativo stato.
La chiamata permette di:
Creare un abbonamento e associare la relativa Card all'utente indicato;
Aggiornare lo stato dell'abbonamento;
Creare o aggiornare l'Utente indicato;
Richiede in ingresso:
Codice Prodotto;
Stato dell'abbonamento
Parametri relativi all'Utente;
Parametri relativi a Card e Vendita;
Restituisce:
Codice della Card appena rilasciata, data di attivazione e scadenza;
Email dell'Utente a cui è associata la Card;
Stato dell'abbonamento
(Opzionale) Lista di licenze Software rilasciate, o info sullo stato del rilascio (in caso di software multipli o errore);
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;
Utente:
Poiché il campo email è obbligatorio, la creazione o l'aggiornamento dell'Utente ai fini dell'allineamento con la base dati del socio verrà gestita esclusivamente tramite la seguente logica:
Utente trovato: l'utente esistente viene associato alla Card, ne vengono eventualmente aggiornati i dati (nome, congnome, numero di telefono).
Utente non trovato: viene creato un nuovo utente con tutti i dati specificati e successivamente viene associato alla Card.
Chiave | Valore |
|---|---|
Indirizzo Test | https://test-apiv2.smiletech.it/APIv2/CardReleaseds/Subscription |
Indirizzo Prod | https://apiv2.smiletech.it/APIv2/CardReleaseds/Subscription |
Metodo | POST |
Success Response | 200 (Success) |
Error Response | 400 (Bad Request) |
Di seguito la struttura dell'Header contenente:
Header
Di seguito la struttura del body contenente i valori da inserire all'interno della richiesta:
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/Subscription
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: 400 Bad Request
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. |