Descrizione delle API per gli sviluppatori

Descrizione delle API per gli sviluppatori

Indice delle API :

Lista clienti

Nuovo cliente

Modifica cliente

Eliminazione cliente

Lista dei gruppi di clienti

Caricamento punti a seguito di una spesa effettuata

Caricamento sconto a seguito di una spesa effettuata

Ricarica del credito prepagato

Pagamento utilizzando gli sconti accumulati


Lista dei clienti

Richiede la lista dei clienti del proprio account.
E' possibile, ma non obbligatorio, aggiungere all'url i parametri PageSize e PageIndex grazie ai quali è possibile paginare l'elenco dei dati ricevuti.

  • URL : https://fcapi.softvision.it/v1/customers
  • Metodo : GET
  • Parametri Url addizionali : pageSize (valore di default 100), PageIndex (valore di default 0)

Esempio di richiesta

GET https://fcapi.softvision.it/v1/customers?PageIndex=0&PageSize=20 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Content-type: application/json
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 753
Date: Sat, 28 Apr 2012 13:19:40 GMT

....Dati Json/Xml...



Aggiunta di un nuovo cliente

Questa funzione permette di aggiungere un nuovo cliente al proprio account. Nella richiesta sarà necessario fornire i dati del cliente in formato Json o XML.

  • URL : https://fcapi.softvision.it/v1/customers
  • Metodo : POST
  • Input richiesto : dati serializzati del cliente in formato Json/xml. Campi obbligatori : CustomersGroupID, FirstName, LastName e CustomerCode
  • Output : dati serializzati del cliente creato

Esempio di richiesta

POST https://fcapi.softvision.it/v1/customers HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Content-type: application/json
Authorization: Bearer TOKEN

...Dati Json/Xml del cliente...

Risposta

HTTP/1.1 201 Created
Content-Type: application/json;charset=utf-8
Content-Length: 253
Date: Sat, 28 Apr 2012 13:19:40 GMT

....Dati Json/Xml del cliente creato...



Modifica dei dati di un cliente

Il funzionamento di questa chiamata è simile al precedente ma permette di modificare la scheda di un cliente anziché di crearla. Trattandosi di una chiamata REST, l'ID del cliente deve essere fornito direttamente nella url.

  • URL : https://fcapi.softvision.it/v1/customers/"CustomerID del cliente da modificare"
  • Metodo : PUT
  • Input richiesto : dati serializzati del cliente in formato Json/xml. Campi obbligatori : CustomersGroupID, FirstName, LastName e CustomerCode
  • Output : nessuno

Esempio di richiesta

PUT https://fcapi.softvision.it/v1/customers/345 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Content-type: application/json
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 200 Ok



Eliminazione di un cliente

Permette di eliminare un cliente dal proprio elenco. Anche in questo caso l'ID del cliente viene fornito direttamente al termine della url.

  • URL : https://fcapi.softvision.it/v1/customers/"CustomerID del cliente da eliminare"
  • Metodo : DELETE

Esempio di richiesta

DELETE https://fcapi.softvision.it/v1/customers/2248 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 204 No Content



Lista dei gruppi di clienti

Richiede la lista dei gruppi di clienti del proprio account.

  • URL : https://fcapi.softvision.it/v1/CustomersGroups
  • Metodo : GET

Esempio di richiesta

GET https://fcapi.softvision.it/v1/CustomersGroups HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN


Risposta

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: 272
Date: Sat, 28 Apr 2012 13:19:40 GMT

....Dati Json/Xml...



Caricamento punti a seguito di una spesa effettuata

Consente di caricare ad un cliente un certo quantitativo di punti calcolato in base alla spesa effettuata fornita in input.

  • URL : https://fcapi.softvision.it/v1/LoadPointsByAmountSpent/"CustomerID del cliente"
  • Metodo : POST
  • Input richiesto : Parametro "Amount" contenente l'importo della spesa effettuata
  • Output : punti caricati ed eventuale sconto accumulato

Esempio di richiesta

POST https://fcapi.softvision.it/v1/LoadPointsByAmountSpent/345 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN

[{"Amount":45.6}]


Risposta

HTTP/1.1 200 Ok
Content-Type: application/json;charset=utf-8
Content-Length: 45
Date: Sat, 28 Apr 2012 13:19:40 GMT

[{"LoadedPoints":230},{"ChargedDiscount":50.30}]



Caricamento sconto a seguito di una spesa effettuata

Consente di caricare ad un cliente un certo sconto calcolato in base alla spesa effettuata fornita in input.

  • URL : https://fcapi.softvision.it/v1/LoadDiscountByAmountSpent/"CustomerID del cliente"
  • Metodo : POST
  • Input richiesto : Parametro "Amount" contenente l'importo della spesa effettuata
  • Output : sconto accumulato ed eventuali punti accumulati

Esempio di richiesta

POST https://fcapi.softvision.it/v1/LoadDiscountByAmountSpent/345 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN

[{"Amount":50.0}]


Risposta

HTTP/1.1 200 Ok
Content-Type: application/json;charset=utf-8
Content-Length: 45
Date: Sat, 28 Apr 2012 13:19:40 GMT

[{"LoadedPoints":100},{"ChargedDiscount":5}]

Ricarica del credito prepagato

Permette di ricaricare (decrementare) il saldo di un credito prepagato di un cliente.

  • URL : https://fcapi.softvision.it/v1/RechargeCredit/"CustomerID del cliente"
  • Metodo : POST
  • Input richiesto : Parametro "Amount" contenente l'importo da ricaricare. Un importo negativo ha l'effetto di decrementare il saldo.
  • Output : sconto accumulato ed eventuali punti accumulati

Esempio di richiesta

POST https://fcapi.softvision.it/v1/RechargeCredit/345 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN

[{"Amount":100.0}]


Risposta

HTTP/1.1 200 Ok
Content-Type: application/json;charset=utf-8
Content-Length: 45
Date: Sat, 28 Apr 2012 13:19:40 GMT

[{"LoadedPoints":200},{"ChargedDiscount",5}]



Pagamento utilizzando gli sconti accumulati

Permette di effettuare un pagamento detraendo l'importo dallo sconto accumulato dal cliente.

  • URL : https://fcapi.softvision.it/v1/PayUsingDiscountCredit/"CustomerID del cliente"
  • Metodo : POST
  • Input richiesto : Parametro "Amount" contenente l'importo addebitare
  • Output : imposto addebitato ed eventuale importo residuo che il cliente deve fornire all'esercente

Esempio di richiesta

POST https://fcapi.softvision.it/v1/PayUsingDiscountCredit/345 HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer TOKEN

[{"Amount":100.0}]


Risposta

HTTP/1.1 200 Ok
Content-Type: application/json;charset=utf-8
Content-Length: 55
Date: Sat, 28 Apr 2012 13:19:40 GMT

[{"AmountCharged":90},{"RemainingAmountToBePaid":",10}] // il cliente deve pagare ancora 10 euro perché il suo saldo era di soli 90 euro a fronte di una spesa di 100 euro.