Cambia lingua

Introduzione

Questa documentazione elenca le funzioni pubbliche con cui è possibile inviare e ricevere dati da applicativi SimplyDevelop attraverso l'applicativo POSWS con chiamate di tipo API REST con scambio dati in formato JSon.

 

Le chiamate verranno inoltrate al POSWS attraverso la porta TCP 4055

 

https://<Indirizzo_IP_POSWS>:4055

 

Es. Per l’url localhost https://127.0.0.1:4055

 

Ogni chiamata API deve essere accompagnata da una SessionCode.

La Session scade dopo 30 minuti dall'ultima chiamata effettuata o immediatamente dopo una login dello stesso utente con la fornitura di un nuovo SessionCode.

 

Operazioni disponibili

 

Method

Operazioni
GET

Ottenere dei record
POST

Ottenere dei record, eliminarne o crearne di nuovi
DELETE

Eliminare dei record 

Autenticazione

L’autenticazione è di tipo Basic Auth, con username e password come specificato in POSWS nella gestione utenti della sezione Midware; Oppure, sempre con username e password, ma con chiamata POST.

 

L'autenticazione può essere fatta nella modalità standard GET o POST come negli esempi delle tabelle di seguito.

 

Method

Url
GET

/api/login

 

Method

Url

Body Text
POST

/api/login

 

{

    "User": "midwareadmin",

    "Password": "xxxxxxxxxxxxxxxx..."

}

Esempio Risposta

 

{

    "ResponseRequest": "login",

    "SuccessStatus": true,

    "SessionCode": "KG0RNCAYLFDVPNDZHT",

    "User": "midwareadmin",

    "Data": "",

    "LastLogin": "1899-12-30T00:00:00.000+01:00"

}

Ordini

Tabella dei campi utilizzabili

 

Element

Description

Type

Max.

Size

Req’d

Read

Only

Filter

order

idorder

ID Ordine

INTEGER

 

 

 

 

orderdate

Data ordine

DATETIME

 

 

 

 

registrationdate

Data registrazione

DATETIME

 

 

 

 

customername

Cliente

STRING

250

 

 

 

customeraddress

Indirizzo cliente

STRING

100

 

 

 

customerzipcode

CAP cliente

STRING

5

 

 

 

customercity

Città cliente

STRING

20

 

 

 

customercountry

Provincia cliente

STRING

2

 

 

 

customerphonenumber

Numero di telefono cliente

STRING

30

 

 

 

customeremail

Indirizzo email cliente

STRING

150

 

 

 

customervatcode

Partita Iva cliente

STRING

16

 

 

 

customertaxcode

Codice Fiscale cliente

STRING

16

 

 

 

customersdi

Codice SDI cliente

STRING

15

 

 

 

customerpec

PEC cliente

STRING

100

 

 

 

orderrows

idroworder

ID riga ordine

INTEGER

 

 

 

 

idproduct

ID prodotto

INTEGER

 

 

 

 

idbarcodeproduct

ID EAN prodotto

INTEGER

 

 

 

 

productcode

Codice prodotto

STRING

30

 

 

 

barcode

Codice EAN

STRING

13

 

 

 

rowdescription

Descrizione riga. Nome Prodotto; Descrizione Sconto...

STRING

1000

 ✓

 

 

price

Prezzo

CURRENCY

 

 ✓

 

 

qtyorder

Quantità ordine. Quantità della riga

DOUBLE

 

 ✓

 

 

iddepartment

ID reparto

INTEGER

 

 

 

 

departmentcode

Codice reparto

INTEGER

 

 ✓

 

 

idvat

ID IVA

INTEGER

 

 

 

 

vatpercentage

Valore percentuale IVA

FLOAT

 

 

 

 

New

La chiamata di inserimento dell'ordine di vendita, può essere fatta con specifica chiamata POST come da esempio della tabella di seguito.

Con questa chiamata viene sostituito il conto in corso sulla cassa.

 

Method

 POST

Url

/api/neworder

Body Text

{

    "orderdate": "2025-09-15T00:00:00.000+01:00",

    "registrationdate": "2025-09-15T00:00:00.000+01:00",

    "customername": "CLIENTE TEST",

    "customeraddress": "VIA ROMA 1",

    "customerzipcode": "00100",

    "customercity": "ROMA",

    "customercountry": "RM",

    "customerphonenumber": "3333333333",

    "customeremail": "clientetest@email.it",

    "customervatcode": "12345678901",

    "customertaxcode": "12345678901",

    "customersdi": "XXXXXXX",

    "customerpec": "clientetest@pec.it",

    "documentrows": [

        {

            "productcode": "AB1234",

            "barcode": "2500000000000",

            "rowdescription": "PRODOTTO PROVA",

            "price": 4.5,

            "qtyorder": 1,

            "departmentcode": "22",

            "vatpercentage": 22

        },

        {

            "productcode": "AB1235",

            "barcode": "2500000000011",

            "rowdescription": "SECONDO PRODOTTO PROVA",

            "price": 2,

            "qtyorder": 1,

            "departmentcode": "3",

            "vatpercentage": 10

        }

    ]

}

Add

La chiamata di aggiunta all'ordine di vendita, può essere fatta con specifica chiamata POST come da esempio della tabella di seguito.

Con questa chiamata si aggiungono prodotti al conto in corso sulla cassa.

 

Method

 POST

Url

/api/addorder

Body Text

{

    "orderdate": "2025-09-15T00:00:00.000+01:00",

    "registrationdate": "2025-09-15T00:00:00.000+01:00",

    "customername": "CLIENTE TEST",

    "customeraddress": "VIA ROMA 1",

    "customerzipcode": "00100",

    "customercity": "ROMA",

    "customercountry": "RM",

    "customerphonenumber": "3333333333",

    "customeremail": "clientetest@email.it",

    "customervatcode": "12345678901",

    "customertaxcode": "12345678901",

    "customersdi": "XXXXXXX",

    "customerpec": "clientetest@pec.it",

    "documentrows": [

        {

            "productcode": "AB1234",

            "barcode": "2500000000000",

            "rowdescription": "PRODOTTO PROVA",

            "price": 4.5,

            "qtyorder": 1,

            "departmentcode": "22",

            "vatpercentage": 22

        },

        {

            "productcode": "AB1235",

            "barcode": "2500000000011",

            "rowdescription": "SECONDO PRODOTTO PROVA",

            "price": 2,

            "qtyorder": 1,

            "departmentcode": "3",

            "vatpercentage": 10

        }

    ]

}