Autorizzazione
Introduzione
EasyAPPEAR utilizza lo standard OAuth 2.
L'Open Authorization o più comunemente OAuth, è un protocollo di comunicazione open mediante il quale un’applicazione (o un servizio web) può gestire in modo sicuro l’accesso autorizzato a risorse protette. Il protocollo è compatibile con qualsiasi tipologia di applicazione: desktop, web e mobile. Il protocollo OAuth è stato ideato da Blaine Cook nel 2006, mentre lavorava all’implementazione Twitter di OpenID, proponendosi come alternativa aperta ai molti protocolli proprietari già esistenti, come Google AuthSub, AOL OpenAuth, Yahoo BBAuth, Flickr API e tanti altri. Dalla versione 1.0 (pubblicata nel 2007) OAuth, ha subìto diverse revisioni, fino all’attuale versione 2.0 che riscrive, quasi completamente, il funzionamento del protocollo perdendo la retrocompatibilità con le versioni precedenti.
Per poter effettuare le richieste API è necessario richiedere un TOKEN di accesso che ha una durata di 2 giorni. (Il parametro di durata potrebbe variare ed è espresso in secondi)
Tutti i parametri da passare in POST devono essere di tipo JSON.
Tutte le risposte saranno di tipo JSON.
In caso di errore o di parametri obbligatori mancanti l'errore restituito sarà di tipo: {"status":"Error","0":500}.
Attenzione: Le risposte delle richieste web service indicate in questa documentazione sono solo degli esempi dimostrativi e parziali del tipo di risposta JSON che il sistema restituisce. Per valutare la risposta effettiva e identificare tutte le informazioni restituite è consigliabile effettuare delle richieste in fase di sviluppo e non basarsi sugli esempi di risposta indicati in quanto sono solo una sintesi che potrebbe variare nel corso del tempo.
Richiesta access token
Di seguito un esempio di richiesta di autenticazione in PHP. (La richiesta può essere fatta in un qualunque linguaggio di programmazione)
URL HTTPS
POST
https://backend.easyappear.it/oauth/token
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
grant_type |
string | Di tipo client_credentials. OBBLIGATORIO |
|
client_id |
string | Codice cliente API fornito assieme alla Chiave segreta. OBBLIGATORIO | |
client_secret |
string | Chiave segreta fornita insieme al Codice cliente.OBBLIGATORIO |
Parametri JSON
{
"grant_type": "client_credentials",
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET"
}
Esempio richiesta PHP
$json_data = '{"grant_type": "client_credentials","client_id": "YOUR_CLIENT_ID","client_secret": "YOUR_CLIENT_SECRET"}';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://backend.easyappear.it/oauth/token');
curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)');
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 100);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'YOUR_CLIENT_ID:YOUR_CLIENT_SECRET');
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Accept: application/json', 'Content-Type: application/json' ));
$result = curl_exec($ch);
Esempio risposta JSON:
{
"token_type":"Bearer",
"expires_in":1295999,
"access_token":"YOUR_ACCESS_TOKEN"
}
Catalogo
Tramite questo set di chiamate è possibile gestire l'intero catalogo prodotti tra cui Categorie, Componenti, Gruppi di componenti, Prodotti, Disponibilità e Prezzi.
Categorie
La sezione categorie consente di inserire o aggiornare l'elenco delle categorie.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_category
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"category_id": "CAT2A_L2",
"parent_category_id": "CAT1A_L1",
"not_update_parent": false,
"not_update_categories": false,
"title": "Illuminazione",
"subtitle": "Lampadari da interno ed esterno",
"media": "http://www...../illuminazione.jpg",
"not_update_image": false,
"position": 3,
"enabled": 1
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
category_id |
string | 50 | Codice interno della categoria. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
parent_category_id |
string | 50 | Codice della categoria padre per creare l'albero di associazione. Esempio: 32141, CAT342, GF3D5GH. |
not_update_parent |
boolean | Non modificare il genitore di questa categoria. Predefinito: false. |
|
not_update_categories |
boolean | Non modifica le i dettagli delle categorie create. Predefinito: false. |
|
title |
string | 100 | Nome visualizzato per identificare la categoria nel relativo elenco.OBBLIGATORIO |
subtitle |
string | 100 | Eventuale sottotitolo dove potrebbe essere necessario. |
media |
url | Indirizzo web per un'immagine di copertina da associare alla categoria. | |
not_update_image |
boolean | Non aggiorna l'immagine. Predefinito: false. |
|
position |
integer | Ordine di visualizzazione della categoria. | |
enabled |
boolean | Abilita/disabilita categoria. Predefinito: true. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"id_parent_category":2,
"title":"Illuminazione",
"subtitle":"Lampadari da interno ed esterno",
"reference":"CAT2A_L2",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/categories/category_1522751905.jpg",
"position":3,
"widget_list":0,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Esportazione Categorie
Restituisce l'elenco delle categorie presenti.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_categories_tree
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"id_parent_category":2,
"title":"Illuminazione",
"subtitle":"Lampadari da interno ed esterno",
"reference":"CAT2A_L2",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/categories/category_1522751905.jpg",
"position":3,
"widget_list":0,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"childs":[...]
}
Esportazione Categoria
Restituisce i dettagli di una singola categoria.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_category
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"id_category": "123456",
"by_reference": false
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
id_category |
string | Codice della categoria. ID o REFERENCE. OBBLIGATORIO |
|
by_reference |
boolean | Se è true controlla per riferimento altrimenti per identificativo EasyAppear. Predefinito: false. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"id_parent_category":2,
"title":"Illuminazione",
"subtitle":"Lampadari da interno ed esterno",
"reference":"CAT2A_L2",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/categories/category_1522751905.jpg",
"position":3,
"widget_list":0,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Componenti
La sezione componenti consente di gestire i componenti che è possibile associare a determinati prodotti.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_component
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"component_id": "CMP123",
"title": "Batterie",
"body": "Batteria n.1 per durata, per tutti i tuoi dispositivi",
"weight": 2.5,
"selling_type": "unit",
"media": "http://www...../batteria.jpg",
"position": 3,
"enabled": 1
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
component_id |
string | 50 | Codice interno del componente. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
title |
string | 100 | Nome visualizzato per identificare il componente nel relativo elenco.OBBLIGATORIO |
body |
text | Eventuale descrizione del componente. | |
weight |
decimal | 10,2 | Peso del componente. |
selling_type |
string | Tipo di vendita. Opzioni: piece o unit. Predefinito: piece. |
|
media |
url | Indirizzo web per un'immagine di copertina da associare al componente. | |
position |
integer | Ordine di visualizzazione del componente. | |
enabled |
boolean | Abilita/disabilita componente. Predefinito: true. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"title":"Batterie",
"reference":"CMP123",
"body":"Batteria n.1 per durata, per tutti i tuoi dispositivi",
"weight":2.5,
"selling_type":"unit",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/components/component_1522751905.jpg",
"position":3,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Gruppi Componenti
La sezione componenti consente di gestire i componenti che è possibile associare a determinati prodotti.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_components_group
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"group_id": "GRP123",
"name": "Tipo lampadina",
"components": ["CMP125","CMP126","CMP127","CMP128","CMP129"]
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
group_id |
string | 50 | Codice interno del gruppo di componenti. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
name |
string | 100 | Nome visualizzato per identificare il gruppo di componenti nel relativo elenco.OBBLIGATORIO |
components |
array | Lista di componenti da associare al gruppo corrente. Esempio: ["CMP125","CMP126","CMP127","CMP128","CMP129"]. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"title":"Tipo lampadina",
"reference":"GRP123",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"components":
[{
"id":55555,
"id_app":88,
"id_company":44,
"title":"E27",
"reference":"CMP125",
"body":,
"weight":,
"selling_type":"piece",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":,
"position":0,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":66666,
"id_app":88,
"id_company":44,
"title":"E28",
"reference":"CMP126",
"body":,
"weight":,
"selling_type":"piece",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":,
"position":0,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":77777,
"id_app":88,
"id_company":44,
"title":"E29",
"reference":"CMP127",
"body":,
"weight":,
"selling_type":"piece",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":,
"position":0,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}]
}
Messaggi Categorie
Questa sezione permette di creare dei messaggi predefiniti per categorie.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_categories_message
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"message_id": "MSG123",
"message": "Confezione regalo",
"position": 3,
"categories": ["CAT2A_L2","CAT56A_L54"]
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
message_id |
string | 50 | Codice interno del messaggio. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
message |
string | 200 | Testo del messaggio.OBBLIGATORIO |
position |
integer | Ordine di visualizzazione del componente. | |
categories |
array | Lista di categorie da associare al prodotto. Esempio: ["CAT2A_L2","CAT56A_L54"]. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"message":"Confezione regalo",
"reference":"MSG123",
"position":3,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"categories":
[{
"id":55555,
"id_app":88,
"id_company":44,
"id_parent_category":2,
"title":"Illuminazione",
"subtitle":"Lampadari da interno ed esterno",
"reference":"CAT2A_L2",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/categories/category_1522751905.jpg",
"position":3,
"widget_list":"0",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":66666,
"id_app":88,
"id_company":44,
"id_parent_category":2,
"title":"Illuminazione Moderna",
"subtitle":"Lampadari moderni da interno ed esterno",
"reference":"CAT56A_L54",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/categories/category_15221215.jpg",
"position":3,
"widget_list":"0",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}]
}
Prodotti
La sezione prodotti consente di inserire o aggiornare prodotti del catalogo.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_product
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"product_id": "CMP123",
"title": "Lampadario LED a batterie",
"subtitle": "Lampada LED da soffitto Philia con colore della luce variabile",
"short_description": "Philia è una lampada ...",
"long_description": "La luce dei LED può essere regolata a piacere, ...",
"url": "https://www.dominio.it/lampadario_CMP123/scheda_tecnica.pdf",
"weight": 2.5,
"selling_type": "piece",
"selling_label": "pz",
"minimum_purchase": 3,
"not_manage_stock": true,
"maximum_customizations": 4,
"position": 3,
"categories": ["CAT2A_L2","CAT56A_L54"] ,
"not_update_data": false,
"not_remove_components": false,
"not_remove_components_groups": false,
"force_subtitle": false,
"not_update_categories": false,
"not_update_images": false,
"not_update_barcodes": false,
"product_type": "shop",
"not_enable_new": false,
"enabled": 1,
"barcodes":
[{
"barcode":8001231231231,
"barcode_id":"BAR123",
"default":false
},
{
"barcode":8004564564564,
"barcode_id":"BAR124",
"default":true
}],
"images":
[{
"media": "http://www...../img_1.jpg",
"position":1
},
{
"media": "http://www...../img_2.jpg",
"position":2
},
{
"media": "http://www...../img_3.jpg",
"position":3
}],
"components":
[{
"table": "components",
"id": "CMP123",
"type": "add",
"price": 3.54,
"weight": 1.30,
"position":1
},
{
"table": "groups",
"id": "GRP133",
"type": "add",
"price": 10.66,
"weight": 2.30,
"position":2
},
{
"table": "components",
"id": "CMP126",
"type": "remove",
"price": ,
"weight": ,
"position":3
},
{
"table": "components",
"id": "CMP128",
"type": "add",
"price": ,
"weight": 2.30,
"position":4
}]
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
product_id |
string | 50 | Codice interno del prodotto. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
title |
string | 100 | Nome visualizzato per identificare il prodotto nel relativo elenco.OBBLIGATORIO |
subtitle |
string | 100 | Eventuale sottotitolo dove potrebbe essere necessario. |
short_description |
text | Eventuale descrizione breve del prodotto. | |
long_description |
text | Eventuale descrizione completa del prodotto. | |
url |
string | 191 | Eventuale URL esterno del prodotto. |
weight |
decimal | 10,2 | Peso del prodotto. |
selling_type |
string | Tipo di vendita. Opzioni: piece o unit. Predefinito: piece. |
|
selling_label |
string | 50 | Etichetta di vendita del prodotto. (Es. Al Kg.). |
minimum_purchase |
integer | Quantità minima che è possibile acquistare. | |
not_manage_stock |
boolean | Non gestire magazzino per questo prodotto. Predefinito: false. |
|
not_remove_components |
boolean | Non rimuovere i componenti da questo prodotto. Se presenti aggiunge soltanto i nuovi. Predefinito: false. |
|
not_remove_components_groups |
boolean | Non rimuovere i gruppi di componenti da questo prodotto. Se presenti aggiunge soltanto i nuovi. Predefinito: false. |
|
not_update_data |
boolean | Non gestire dati per questo prodotto. Predefinito: false. Campi interessati: title subtitle short_description long_description weight. |
|
force_subtitle |
boolean | Se not_update_data è true allora forza l'aggiornamento di subtitle. Predefinito: false. |
|
not_update_categories |
boolean | Non modifica le categorie associate a questo prodotto. Predefinito: false. |
|
not_enable_new |
boolean | Non abilita in automatico un nuovo prodotto. Predefinito: false. |
|
enabled |
boolean | Abilita/disabilita un prodotto. Predefinito: true. |
|
not_update_images |
boolean | Non gestire immagini per questo prodotto. Predefinito: false. |
|
not_update_barcodes |
boolean | Non gestire i barcode per questo prodotto. Predefinito: false. |
|
maximum_customizations |
integer | Numero massimo di personalizzazioni. | |
position |
integer | Ordine di visualizzazione del prodotto. | |
product_type |
string | Tipo di prodotto. Opzioni: shop, rental o booking. Predefinito: shop. |
|
categories |
array | Lista di categorie da associare al prodotto. Esempio: ["CAT123","CAT124","CAT125","CAT126","CAT127"]. |
|
barcodes |
object | Lista di codici a barre da associare al prodotto. Lasciando il campo vuoto verranno rimossi tutti i barcode associati. Vedi Prodotti - Parametri barcodes. |
|
images |
object | Lista di immagini da associare al prodotto. Lasciando il campo vuoto verranno rimosse tutte le immagini associate. Vedi Prodotti - Parametri images. |
|
components |
object | Lista dei componenti o gruppi di componenti da associare al prodotto. Lasciando il campo vuoto verranno rimossi tutti i componenti/gruppi di componenti associati. Vedi Prodotti - Parametri components. |
Prodotti - Parametri barcodes
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
barcode |
string | 20 | Codice a barre. OBBLIGATORIO |
barcode_id |
string | 50 | Identificativo del codice a barre. OBBLIGATORIO |
default |
boolean | Indica se il codice a barre è il principale per il relativo prodotto. Predefinito: false. |
Prodotti - Parametri images
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
media |
url | Indirizzo web dell'immagine da associare al prodotto. OBBLIGATORIO | |
position |
integer | Ordine di visualizzazione dell'immagine. |
Prodotti - Parametri components
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
table |
string | Tipo di componente. Opzioni: components o groups. OBBLIGATORIO |
|
id |
string | 50 | Codice di riferimento del tipo "table" indicato. OBBLIGATORIO |
type |
string | Se è possibile aggiungere o rimuovere questo elemento. Opzioni: add o remove. Predefinito: add. OBBLIGATORIO |
|
price |
decimal | 10,2 | Prezzo della variazione. |
weight |
decimal | 10,2 | Peso della variazione. |
position |
integer | Ordine di visualizzazione della variazione. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"title":"Lampadario LED a batterie",
"subtitle":"Lampada LED da soffitto Philia con colore della luce variabile",
"reference":"Lampadario LED a batterie",
"short_description":"Philia è una lampada ...",
"long_description":"La luce dei LED può essere regolata a piacere, ...",
"url":"https://www.dominio.it/lampadario_CMP123/scheda_tecnica.pdf",
"weight":2.5,
"selling_type":"piece",
"minimum_purchase":3,
"not_manage_stock":true,
"maximum_customizations":4,
"position":3,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"categories":
[{
"id":55555,
"id_app":88,
"id_company":44,
"id_parent_category":2,
"title":"Illuminazione",
"subtitle":"Lampadari da interno ed esterno",
"reference":"CAT2A_L2",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/categories/category_1522751905.jpg",
"position":3,
"widget_list":"0",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":66666,
"id_app":88,
"id_company":44,
"id_parent_category":2,
"title":"Illuminazione Moderna",
"subtitle":"Lampadari moderni da interno ed esterno",
"reference":"CAT56A_L54",
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/categories/category_15221215.jpg",
"position":3,
"widget_list":"0",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}],
"barcodes":
[{
"id":55555,
"id_app":88,
"id_company":44,
"id_product":453,
"barcode":8001231231231,
"reference":"BAR123",
"default":0,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":66666,
"id_app":88,
"id_company":44,
"id_product":453,
"barcode":8004564564564,
"reference":"BAR124",
"default":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}],
"images":
[{
"id":55555,
"id_app":88,
"id_company":44,
"id_product":453,
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/products/product_1522751905.jpg",
"position":1,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":66666,
"id_app":88,
"id_company":44,
"id_product":453,
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/products/product_1522723423.jpg",
"position":2,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":77777,
"id_app":88,
"id_company":44,
"id_product":453,
"base_url":"https://http://backend.easyappear.it/storage/",
"media":"app_name_443/products/product_12143205.jpg",
"position":3,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}],
"components":
[{
"id":55555,
"id_app":88,
"id_company":44,
"id_product":453,
"id_component":545,
"id_component_group":,
"type":"add",
"price": 3.54,
"weight": 1.30,
"position":1,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":66666,
"id_app":88,
"id_company":44,
"id_product":453,
"id_component":,
"id_component_group":2432,
"type":"add",
"price": 10.66,
"weight": 2.30,
"position":2,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":77777,
"id_app":88,
"id_company":44,
"id_product":453,
"id_component":3424,
"id_component_group":,
"type":"remove",
"price": ,
"weight": ,
"position":3,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":88888,
"id_app":88,
"id_company":44,
"id_product":453,
"id_component":3425,
"id_component_group":,
"type":"add",
"price": ,
"weight": 2.30,
"position":4,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}]
}
Esportazione Prodotti Categoria
Restituisce i prodotti appartenenti ad una categoria.
La chiamata restituisce un numero massimo di prodotti.
Tramite un meccanismo di paginazione dei risultati è possibile ottenete i prodotti della pagina 1, 2, 3, ecc...
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_products
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"id_category": 123456,
"skip": 0,
"take": 10,
"show_disabled": false
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
id_category |
integer | Identificativo categoria EasyAppear. OBBLIGATORIO | |
skip |
integer | Numero di elementi da cui iniziare ad esportare l'elenco. | |
take |
integer | Numero massimo di elementi da esportare. | |
show_disabled |
boolean | Mostra anche i prodotti disabilitatati. Predefinito: false. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"title":"Lampadario LED a batterie",
"subtitle":"Lampada LED da soffitto Philia con colore della luce variabile",
"reference":"Lampadario LED a batterie",
"short_description":"Philia è una lampada ...",
"long_description":"La luce dei LED può essere regolata a piacere, ...",
"url":"https://www.dominio.it/lampadario_CMP123/scheda_tecnica.pdf",
"weight":2.5,
"selling_type":"piece",
"minimum_purchase":3,
"not_manage_stock":true,
"maximum_customizations":4,
"position":3,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Esportazione Prodotto
Restituisce i dettagli di un prodotto.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_product
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"id_product": 123456,
"show_disabled": false
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
id_product |
integer | Codice interno del prodotto. OBBLIGATORIO | |
show_disabled |
boolean | Mostra anche i prodotti disabilitatati. Predefinito: false. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"title":"Lampadario LED a batterie",
"subtitle":"Lampada LED da soffitto Philia con colore della luce variabile",
"reference":"Lampadario LED a batterie",
"short_description":"Philia è una lampada ...",
"long_description":"La luce dei LED può essere regolata a piacere, ...",
"url":"https://www.dominio.it/lampadario_CMP123/scheda_tecnica.pdf",
"weight":2.5,
"selling_type":"piece",
"minimum_purchase":3,
"not_manage_stock":true,
"maximum_customizations":4,
"position":3,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Esportazione Prodotto Per Riferimento
Restituisce i dettagli di un prodotto.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_product_reference
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"product_id": "PROD1234",
"show_disabled": false
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
product_id |
string | Riferimento del prodotto. OBBLIGATORIO | |
show_disabled |
boolean | Mostra anche i prodotti disabilitatati. Predefinito: false. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"title":"Lampadario LED a batterie",
"subtitle":"Lampada LED da soffitto Philia con colore della luce variabile",
"reference":"Lampadario LED a batterie",
"short_description":"Philia è una lampada ...",
"long_description":"La luce dei LED può essere regolata a piacere, ...",
"url":"https://www.dominio.it/lampadario_CMP123/scheda_tecnica.pdf",
"weight":2.5,
"selling_type":"piece",
"minimum_purchase":3,
"not_manage_stock":true,
"maximum_customizations":4,
"position":3,
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Disponibilità Prodotti
La sezione permette di gestire le giacenze di magazzino dei prodotti.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_product_stock
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"product_id": "PRO123",
"stock": 300
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
product_id |
string | 50 | Codice interno del gruppo di componenti. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
stock |
integer | Disponibilità del prodotto.OBBLIGATORIO |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"id_product":453,
"stock":300,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Prezzi Prodotti
La sezione permette di gestire i listini prezzo dei prodotti.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_product_price
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"product_id": "PRO123",
"prices":
[{
"price":23,
"default":true
},
{
"customers_group_id":"GRUL2",
"price":22,
"combined_price":23,
"default":false,
"minimum_quantity":5,
"available_from":"2022-11-01 11:27:00",
"available_to":"2022-11-30 11:27:00"
},
{
"customers_group_id":"GRUL2",
"price":20,
"combined_price":21,
"default":false,
"minimum_quantity":10,
"available_from":"2022-11-01 11:27:00",
"available_to":"2022-11-30 11:27:00"
}]
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
product_id |
string | 50 | Codice interno del gruppo di componenti. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
prices |
object | Listino prezzi da associare al prodotto. Lasciando il campo vuoto verranno rimossi tutti i prezzi. Vedi Prodotti - Parametri prices. |
Prodotti - Parametri prices
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
customers_group_id |
string | 50 | Codice del gruppo di clienti. Esempio: 32141, GF3D5GH |
price |
decimal | 10,2 | Prezzo unitario del prodotto. OBBLIGATORIO |
combined_price |
decimal | 10,2 | Prezzo del prodotto se combinato con un altro. |
default |
boolean | Indica se il prezzo è quello di base. Predefinito: false. |
|
minimum_quantity |
integer | Quantità minima da acquistare per ottenere il prezzo indicato. | |
available_from |
date-time | Data da cui impostare il prezzo. Esempio: 2022-11-01 11:27:00. |
|
available_to |
date-time | Data fino cui impostare il prezzo. Esempio: 2022-11-01 11:27:00. |
Esempio risposta JSON:
[{
"id":55555,
"id_app":88,
"id_company":44,
"id_product":453,
"id_customers_group":,
"price":23,
"combined_price":,
"minimum_quantity":,
"available_from":,
"available_to":,
"default":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":66666,
"id_app":88,
"id_company":44,
"id_product":453,
"id_customers_group":3231,
"price":22,
"combined_price":23,
"minimum_quantity":5,
"available_from":"2022-11-01 11:27:00",
"available_to":"2022-11-30 11:27:00",
"default":0,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":77777,
"id_app":88,
"id_company":44,
"id_product":453,
"id_customers_group":3231,
"price":21,
"combined_price":22,
"minimum_quantity":10,
"available_from":"2022-11-01 11:27:00",
"available_to":"2022-11-30 11:27:00",
"default":0,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}]
Cancellazione Categoria
Permette la cancellazione di una categoria.
Se la categoria contiene altre sotto-categorie anche esse verranno eliminate.
Tutti i prodotti associati alle categorie coinvolte nella cancellazzione non risulteranno più associati alle stesse.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_category
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"category_id": "CAT2A_L2"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
category_id |
string | 50 | Codice interno della categoria. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Cancellazione Componente
Permette la cancellazione di un componente.
Tutti i prodotti associati al componente saranno slegati dallo stesso.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_component
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"component_id": "CMP123"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
component_id |
string | 50 | Codice interno del componente. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Cancellazione Gruppo Componenti
Permette la cancellazione di un gruppo componenti.
Tutti i prodotti associati al gruppo componenti saranno slegati dallo stesso.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_components_group
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"group_id": "GRP123"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
group_id |
string | 50 | Codice interno del gruppo di componenti. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Cancellazione Messaggio Categorie
Permette la cancellazione di un messaggio.
Tutte le categorie associate a quel messaggio verranno slegate dallo stesso.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_categories_message
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"message_id": "MSG123"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
message_id |
string | 50 | Codice interno del messaggio. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Cancellazione Prodotto
Permette la cancellazione totale di un prodotto.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_product
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"product_id": "PRO123"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
product_id |
string | 50 | Codice interno del prodotto. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Abilita/Disabilita Catalogo
Permette di abilitare/disabilitare tutti i prodotti del catalogo.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/enable_disable_all_products
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"enabled": false
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
enabled |
boolean | Stato del catalogo. Opzioni: true o false. |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Svuota Negozio
Permette la cancellazione totale di tutti i prodotti, categorie, componenti, messaggi, ecc...
La cancellazzione rimuoverà le associazioni con eventuali ordini che non verranno eliminati.
Per motivi di sicurezza non è possibile effettuare più di una chiamata per volta.
La chiamata può essere effettuata un asola volta ogni 24 ore.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/clear_shop
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Camerieri Digitali
Tramite questo set di chiamate è possibile gestire i dispositivi associati ad uno specifico tavolo.
Gestione Camerieri Digitali
Associa uno specifico dispositivo ad un tavolo.
Per effettuare questa chiama API è necessario inviare il parametro in POST nel JSON "device_id".
Il parametro "device_id" va recuperato dalla scheda "Info APP" nell'app installata sul dispositivo.
Per rimuovere un'associazione Dispositivo/Tavolo inviare i parametri "table_id" e "name" con valore NULL.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_digital_waiter
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"device_id": "YOUR_DEVICE_ID",
"table_id": "TAV1",
"name": "Tavolo 1"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
device_id |
string | 50 | Codice univoco del dispositivo. Vedi "Info APP" nell'app installata sul dispositivo.OBBLIGATORIO |
table_id |
string | 50 | Codice interno del tavolo. Esempio: TAV1, GF3D5GH. |
name |
string | 100 | Nome del tavolo. Esempio: Tavolo 1.OBBLIGATORIO |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"id_app_customer":342,
"uid_device":A39D004B-4A2133D-4213SADF7-9B232137-942ASDSADB1214,
"token_notification":SSDFDS-FDS75FD6SF5-7DS6F7D5S7-A5FD7ASD,
"token_device":SXDFD12
"device_model":iPhone8,1,
"platform":iOS,
"platform_version":11.1.2,
"last_activity":2040-12-18 14:52:07,
"last_coordinates":21.1612131,17.3212937,
"test_user":,
"reference":TAV1,
"name":Tavolo 1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Postazioni
Tramite questo set di chiamate è possibile rigenerare i codici delle postazioni e ottenere il codice QR della stessa.
QrCode: http://app.cmh.it/?id_app&position=id&name=name&reference=reference&token=token
Gestione Postazioni
La sezione postazioni consente di inserire o aggiornare l'elenco delle postazioni.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_position
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"position_id": "POS1",
"name": "Postazione 1",
"enabled": true
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
position_id |
string | 50 | Codice interno della postazione. Esempio: POS1, GF3D5GH.OBBLIGATORIO |
name |
string | 50 | Nome della postazione. |
enabled |
boolean | Abilita/disabilita postazione. Predefinito: true. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"reference":"POS1",
"name":"Postazione 1",
"token":"152321 ... ",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"qrcode":"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAPoAAAD ... "
}
Dati Postazione
Restituisce i dati di una specifica postazione.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_position
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"position_id": "POS1"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
position_id |
string | 50 | Codice interno della postazione. Esempio: POS1, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"reference":"POS1",
"name":"Postazione 1",
"token":"152321 ... ",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"qrcode":"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAPoAAAD ... "
}
Rigenera Dati Postazione
Rigenera i dati di una specifica postazione e restituisce il relativi dati aggiornati.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/refresh_position
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"position_id": "POS1"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
position_id |
string | 50 | Codice interno della postazione. Esempio: POS1, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"reference":"POS1",
"name":"Postazione 1",
"token":"152321 ... ",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"qrcode":"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAPoAAAD ... "
}
Cancellazione Postazione
Permette la cancellazione di una postazione.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_position
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"position_id": "POS1"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
position_id |
string | 50 | Codice interno della postazione. Esempio: POS1, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Abilita/Disabilita Postazioni
Permette di abilitare/disabilitare tutte le postazioni.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/enable_disable_positions
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"enabled": false
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
enabled |
boolean | Stato delle postazioni. Opzioni: true o false. |
Esempio risposta JSON:
{
"status":OK,
"code":200
}
Ordini
Tramite questo set di chiamate è possibile reperire gli ordini effettuati e modificare il loro stato.
Elenco Ordini
Restituisce gli ordini ricevuti.
La chiamata restituisce al massimo 10 ordini.
Tramite un meccanismo di paginazione dei risultati è possibile ottenete gli ordini della pagina 1, 2, 3, ecc...
Nota: E' possibile specificare un URL che verrà notificato ad ogni nuovo ordine ricevuto nella sezione Impostazioni > Generale > URL di Notifica Nuovo ordine. Il sistema invierà in POST il dettaglio del nuovo ordine per poterlo acquisite in maniera istantanea.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_orders
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"state": "new",
"page": 1,
"id_location": 11212,
"created_at": "2022-04-03 12:38:26"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
state |
string | Stato degli ordini. Opzioni: new, in_approval, confirmed, in_progress, shipped, delivered, canceled. Predefinito: new. |
|
page |
integer | Numero di pagina. Esempio: 1, 2. Predefinito: 1. |
|
id_location |
integer | Restituisce gli ordini di una determinara sede. | |
created_at |
datetime | Data da cui iniziare la sincronizzazione. |
Esempio risposta JSON:
{
"orders":
[{
"id":55555,
"id_app":88,
"id_company":44,
"id_app_customer":342,
"id_device":,
"id_position":342,
"app_token_key":342,
"reference":"RBV1XZT",
"invoice_name":"TAVOLO 34",
"invoice_surname":,
"invoice_address":,
"invoice_zip_code":,
"invoice_city":,
"invoice_province":,
"invoice_state":,
"invoice_phone":,
"invoice_mobile":,
"invoice_fax":,
"invoice_email":,
"delivery_name":"TAVOLO 34",
"delivery_surname":,
"delivery_address":,
"delivery_zip_code":,
"delivery_city":,
"delivery_province":,
"delivery_state":,
"delivery_phone":,
"delivery_mobile":,
"delivery_fax":,
"delivery_email":,
"number_persons":4,
"total_cover_charge":8,
"total_service_charge":5,
"device_reference":,
"device_name":,
"position_token":"9999999...",
"position_reference":"tav_34",
"position_name":"TAVOLO 34",
"delivery_time":"2024-05-30 20:30:0",
"rental_time_value":,
"rental_time_type":,
"rental_minutes":,
"rental_start_at":,
"rental_end_at":,
"order_type":"shop",
"total_discount":0.00,
"total_shipping":0.00,
"total_products":40.50,
"total_paid":53.50,
"shipping_type":"self_order",
"payment_type":"cash_desk",
"note":,
"previous_state":"to_confirm",
"state":"new",
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"products":,
[{
"id":6666,
"id_app":88,
"id_company":44,
"id_order":55555,
"id_product":3333,
"title":"Pasta alla Carbonara",
"reference":,
"barcode":,
"weight":,
"quantity":2,
"discount":0.00,
"price":6.56,
"total":13.12,
"note":,
"position":0,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26",
"components":,
[{
"id":6666,
"id_app":88,
"id_company":44,
"id_order":55555,
"id_order_row":88888,
"id_product":3333,
"title":"Funghi (+ 0.56€)",
"reference":,
"type":"add",
"price":0.56,
"weight":,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":6666,
"id_app":88,
"id_company":44,
"id_order":55555,
....
}],
"messages":,
[{
"id":6666,
"id_app":88,
"id_company":44,
"id_order":55555,
"id_order_row":88888,
"id_product":3333,
"id_message":4444,
"message":"Senza Glutine",
"reference":,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"id":6666,
"id_app":88,
"id_company":44,
"id_order":55555,
....
}],
},
{
"id":6666,
"id_app":88,
"id_company":44,
"id_order":55555,
....
}],
},
{
id":55555,
"id_app":88,
"id_company":44,
"id_app_customer":342,
"reference":"RBV1UYT",
...
},
{
id":55555,
"id_app":88,
"id_company":44,
"id_app_customer":342,
"reference":"R561XZT",
...
}]
}
Dettagli Ordine
Restituisce la svcehda dettagliata di un singolo ordine.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_order
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"order_id": "RBV1XZT"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
order_id |
string | 50 | Codice dell'ordine. Esempio: RBV1XZT. OBBLIGATORIO |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"id_app_customer":342,
"reference":"RBV1XZT",
"invoice_name":"TAVOLO 34",
"invoice_surname":,
"invoice_address":,
"invoice_zip_code":,
"invoice_city":,
"invoice_province":,
"invoice_state":,
"invoice_phone":,
"invoice_mobile":,
"invoice_fax":,
"invoice_email":,
"delivery_name":"TAVOLO 34",
"delivery_surname":,
"delivery_address":,
"delivery_zip_code":,
"delivery_city":,
"delivery_province":,
"delivery_state":,
"delivery_phone":,
"delivery_mobile":,
"delivery_fax":,
"delivery_email":,
"number_persons":4,
"total_cover_charge":8,
"total_service_charge":5,
"table_reference":"tav_34",
"table_name":"TAVOLO 34",
"total_discount":0.00,
"total_shipping":0.00,
"total_products":40.50,
"total_paid":53.50,
"shipping_type":"self_order",
"note":,
"state":"shipped",
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Imposta Stato Ordine
Modifica lo stato di un ordine.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_order_state
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"order_id": "RBV1XZT",
"state": "shipped",
"payment_type": "paypal_express",
"delivery_time": "2022-04-03 12:38:26",
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
order_id |
string | 50 | Codice dell'ordine. Esempio: RBV1XZT. OBBLIGATORIO |
state |
string | Stato degli ordini. Opzioni: new, in_approval, confirmed, in_progress, shipped, delivered, canceled. OBBLIGATORIO |
|
delivery_time |
datetime | Data di evasione dell'ordine. | |
payment_type |
string | Tipo di pagamento. Opzioni: cash_desk, cash_on_delivery, wire_transfer, paypal, paypal_express, postepay, sumup, mypos, loyalty_amount. |
|
note |
text | Note dell'ordine. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"id_app_customer":342,
"reference":"RBV1XZT",
"invoice_name":"TAVOLO 34",
"invoice_surname":,
"invoice_address":,
"invoice_zip_code":,
"invoice_city":,
"invoice_province":,
"invoice_state":,
"invoice_phone":,
"invoice_mobile":,
"invoice_fax":,
"invoice_email":,
"delivery_name":"TAVOLO 34",
"delivery_surname":,
"delivery_address":,
"delivery_zip_code":,
"delivery_city":,
"delivery_province":,
"delivery_state":,
"delivery_phone":,
"delivery_mobile":,
"delivery_fax":,
"delivery_email":,
"number_persons":4,
"total_cover_charge":8,
"total_service_charge":5,
"table_reference":"tav_34",
"table_name":"TAVOLO 34",
"total_discount":0.00,
"total_shipping":0.00,
"total_products":40.50,
"total_paid":53.50,
"shipping_type":"self_order",
"note":,
"state":"shipped",
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Gestione riga ordine
Modifica oppure inserisce una nuova riga di un ordine.
Se il parametro "id_row" non viene valorizzato la riga verrà aggiunta all'ordine. Se valorizzato la riga verrà sostituita con i nuovi parametri.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_order_row
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"order_id": "RBV1XZT",
"id_row": 999999,
"product_id": "PRO123",
"title": "Lampadario LED a batterie",
"barcode": "8001231231231",
"quantity": 2.00,
"price": 23.00
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
order_id |
string | 50 | Codice dell'ordine. Esempio: RBV1XZT. OBBLIGATORIO |
id_row |
int | 999999 | Identificatore della riga. Esempio: NULL, 999999 |
product_id |
string | 50 | Codice interno del prodotto. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
title |
string | 100 | Nome del prodotto.OBBLIGATORIO |
barcode |
string | 20 | Codice a barre. |
quantity |
decimal | 10,2 | Quantità ordinata.OBBLIGATORIO |
price |
decimal | 10,2 | Prezzo unitario del prodotto. OBBLIGATORIO |
Esempio risposta JSON:
{
"id":999999,
"id_app":88,
"id_company":44,
"id_order":666,
"id_product":999,
"reference":999,
"selling_type":"piece",
"selling_label":,
"weight":2.5,
"title":"Lampadario LED a batterie",
"barcode":"8001231231231",
"quantity":2.00,
"price":23.00,
"total":46.00,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Elimina ordine
Elimina un ordine.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_order
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"order_id": "RBV1XZT"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
order_id |
string | 50 | Codice dell'ordine. Esempio: RBV1XZT. OBBLIGATORIO |
Esempio risposta JSON:
{
"status":"success",
"type":"order_deleted",
"message":" Order deleted"
}
Elimina riga ordine
Elimina la riga di un ordine.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_order_row
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"order_id": "RBV1XZT",
"id_row": 999999
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
order_id |
string | 50 | Codice dell'ordine. Esempio: RBV1XZT. OBBLIGATORIO |
id_row |
int | 999999 | Identificatore della riga. OBBLIGATORIO |
Esempio risposta JSON:
{
"id":999999,
"id_app":88,
"id_company":44,
"id_order":666,
"id_product":999,
"reference":999,
"selling_type":"piece",
"selling_label":,
"weight":2.5,
"title":"Lampadario LED a batterie",
"barcode":"8001231231231",
"quantity":2.00,
"price":23.00,
"total":46.00,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Orari Consegne
Tramite questo set di chiamate è possibile interrogare e gestire gli orari di consegna per determinati metodi di spedizione.
Utile per occupare o liberare reparti di lavorazione che non provengono dai flussi standard. Ad esempio ordini telefonici.
Tabella Orari Consegna
Mostra la tabella oraria di lavoro per un determinato metodo di consegna e indica se un determinato giorno oppure orario è disponibile o meno
E' possibile specificare un insieme di prodotti e relativa quantità per ottenere l'informazione della disponibilità per quell'insieme
Se si vuole solo avere un'idea di riempimento dei reparti è possibile passare dei dati vuoti in questo modo: "cart":[{"id_product":null,"quantity":null}]
Questo metodo consente di replicare lo stesso funzionamento dell'app quando si seleziona un giorno ed un'ora di consegna dal calendario.
Il parametro in risposta "available" indica se il giorno ha slot disponibili e quale slot del giorno in questione e disponibile. ( 0 = Non disponibile, 1 = Disponibile )
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_business_hours
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"delivery_type": "pick_pay",
"from": "2022-04-01",
"to": "2022-04-30"
"by_reference": true,
"cart":
[{
"id":"PRO123",
"quantity":2
},
{
"id":"PRO456",
"quantity":6
},
{
"id":"PRO789",
"quantity":1
}]
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
delivery_type |
string | 50 | Metodo di spedizione tra: Ritiro in sede, Corriere e Fattorino. Opzioni: pick_pay, courrier o pony_express. OBBLIGATORIO |
from |
date | Data da quando iniziare a recuperare le informazioni. Esempio: 2022-04-01. OBBLIGATORIO |
|
to |
date | Data fino a quando recuperare le informazioni. Esempio: 2022-04-30. OBBLIGATORIO |
|
by_reference |
boolean | Se è true controlla per riferimento altrimenti per identificativo EasyAppear. Predefinito: false. |
|
cart |
array | Insieme per cui controllare la disponibilità. Esempio: [{"id_product":null,"quantity":null}] oppure [{"id_product":"PRO123","quantity":2},...]. |
Esempio risposta JSON:
{
"2022-04-01":
{
"available": 0,
"slots":
[
[
{
"available": 0,
"time": "11:30:00"
},
{
"available": 0,
"time": "12:00:00"
},
{
"available": 0,
"time": "12:30:00"
},
{
"available": 0,
"time": "13:00:00"
}],
[{
"available": 0,
"time": "18:30:00"
},
{
"available": 0,
"time": "19:00:00"
},
{
"available": 0,
"time": "19:30:00"
},
{
"available": 0,
"time": "20:00:00"
}
]
]
},
"2022-04-02":
{
"available": 1,
"slots":
[
[
{
"available": 0,
"time": "11:30:00"
},
{
"available": 1,
"time": "12:00:00"
},
{
"available": 0,
"time": "12:30:00"
},
{
"available": 1,
"time": "13:00:00"
}],
[{
"available": 0,
"time": "18:30:00"
},
{
"available": 0,
"time": "19:00:00"
},
{
"available": 1,
"time": "19:30:00"
},
{
"available": 1,
"time": "20:00:00"
}
]
]
}
}
Verifica Ora Consegna
Verifica se un determinato orario di consegna è ancora disponibile
E' possibile specificare un insieme di prodotti e relativa quantità per ottenere l'informazione della disponibilità per quell'insieme
Se si vuole solo sapere se è disponibile a prescindere dall'insieme è possibile passare dei dati vuoti in questo modo: "cart":[{"id_product":null,"quantity":null}]
URL HTTPS
POST
https://backend.easyappear.it/rest_api/check_business_hours
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"delivery_type": "pick_pay",
"delivery_time": "2022-04-02 20:00",
"by_reference": true,
"cart":
[{
"id":"PRO123",
"quantity":2
},
{
"id":"PRO456",
"quantity":6
},
{
"id":"PRO789",
"quantity":1
}]
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
delivery_type |
string | 50 | Metodo di spedizione tra: Ritiro in sede, Corriere e Fattorino. Opzioni: pick_pay, courrier o pony_express. OBBLIGATORIO |
delivery_time |
date-time | Orario da verificare. Esempio: 2022-04-02 20:00. OBBLIGATORIO |
|
by_reference |
boolean | Se è true controlla per riferimento altrimenti per identificativo EasyAppear. Predefinito: false. |
|
cart |
array | Insieme per cui controllare la disponibilità. Esempio: [{"id_product":null,"quantity":null}] oppure [{"id_product":"PRO123","quantity":2},...]. |
Esempio risposta JSON:
{
"status": "success",
"type": "availlable",
"message": "Availlable"
}
Occupa un Oraraio
Permette di occupare un reparto in maniera forzata senza passare dai flussi standard del'app.
Questo metodo non controlla l'effettiva disponibilità, ma forza a prescindere l'inserimento.
Verificare sempre prima la disponibilità della fascia oraria con i metodi "get_business_hours" oppure "check_business_hours".
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_slot_occupation
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"delivery_type": "pick_pay",
"delivery_time": "2022-04-02 20:00",
"by_reference": true,
"cart":
[{
"id":"PRO123",
"quantity":2
},
{
"id":"PRO456",
"quantity":6
},
{
"id":"PRO789",
"quantity":1
}]
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
delivery_type |
string | 50 | Metodo di spedizione tra: Ritiro in sede, Corriere e Fattorino. Opzioni: pick_pay, courrier o pony_express. OBBLIGATORIO |
delivery_time |
date-time | Orario da verificare. Esempio: 2022-04-02 20:00. OBBLIGATORIO |
|
by_reference |
boolean | Se è true controlla per riferimento altrimenti per identificativo EasyAppear. Predefinito: false. |
|
cart |
array | Insieme per cui occupare la fascia oraria. |
Esempio risposta JSON:
{
"status": "success",
"type": "slot_occupied",
"message": "Slot occupied"
}
Libera un Orario
Elimina l'eventuale occupazione di un reparto in base ai prodotti passati.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/delete_slot_occupation
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"delivery_type": "pick_pay",
"delivery_time": "2022-04-02 20:00",
"by_reference": true,
"cart":
[{
"id":"PRO123",
"quantity":2
},
{
"id":"PRO456",
"quantity":6
},
{
"id":"PRO789",
"quantity":1
}]
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
delivery_type |
string | 50 | Metodo di spedizione tra: Ritiro in sede, Corriere e Fattorino. Opzioni: pick_pay, courrier o pony_express. OBBLIGATORIO |
delivery_time |
date-time | Orario da verificare. Esempio: 2022-04-02 20:00. OBBLIGATORIO |
|
by_reference |
boolean | Se è true controlla per riferimento altrimenti per identificativo EasyAppear. Predefinito: false. |
|
cart |
array | Insieme per cui libebrare la fascia oraria. |
Esempio risposta JSON:
{
"status": "success",
"type": "slot_occupied",
"message": "Slot occupied"
}
Campagne di Fidelizzazione
Tramite questo set di chiamate è possibile gestire le campagne di fidelizzazione e le transazioni sulle card digitali del portfolio clienti.
Attività
Gestione attività delle campagne promozionali.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_loyalty_type
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"type_id": "TYP123",
"name": "Prepagato",
"description": "Attività per carta prepagata",
"type": "€",
"ratio": 1,
"decimals": "2"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
type_id |
string | 50 | Codice interno del tipo di attività. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
name |
string | 50 | Nome attività. OBBLIGATORIO |
description |
string | Destizione attività. | |
type |
string | 5 | Simbolo attività. |
ratio |
decimal | 8,2 | Rapporto di conversione Valuta/Attivita. Predefinito: 0 |
decimals |
char | Numero di cifre decimali. Opzioni: 0, 1, 2 o 3. Predefinito: 2. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"name":"Prepagato",
"reference":"TYP123",
"description":"Attività per carta prepagata",
"type":"€",
"ratio":1,
"decimals":"2",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Campagne
Gestione delle campagne promozionali.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_loyalty_program
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"program_id": "PRG123",
"name": "Raccolta punti",
"description": "Campagna di raccolta punti Gennaio/Dicembre",
"program_from": "2022-01-01 00:00:00",
"program_to": "2022-12-31 23:59:59",
"program_deadline": "2023-02-28 23:59:59"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
program_id |
string | 50 | Codice interno della campagna promozionale. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
name |
string | Nome campagna promozionale. OBBLIGATORIO | |
description |
string | Destizione campagna promozionale. | |
program_from |
date-time | Data di inizio campagna promozionale. Esempio: 2022-01-01 00:00:00. |
|
program_to |
date-time | Data di fine campagna promozionale. Esempio: 2022-12-31 23:59:59. |
|
program_deadline |
date-time | Data entro cui è possibile utilizzare il saldo. Esempio: 2023-02-28 23:59:59. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"name":"Raccolta punti",
"reference":"PRG123",
"description":"Campagna di raccolta punti Gennaio/Dicembre",
"program_from":"2022-01-01 00:00:00",
"program_to":"2022-12-31 23:59:59",
"program_deadline":"2023-02-28 23:59:59",
"enabled":1,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Transazioni
Crea una nuova transazione su una determinata card.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_transaction
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"type_id": "TYP123",
"type": "Punti",
"ratio": 1,
"decimals": "0",
"program_id": "PRG123",
"program": "Raccolta punti",
"program_from": "2022-01-01 00:00:00",
"program_to": "2022-12-31 23:59:59",
"program_deadline": "2023-02-28 23:59:59",
"card_number": "XXXXXXXXXXXXX",
"operation": "plus",
"value": 30,
"apply_ratio": false,
"note":"Carico punti",
"operation_date": "2022-03-12 16:30:20",
"show_errors": true
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
type_id |
string | 50 | Codice interno del tipo di attività. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
type |
string | 50 | Nome attività. OBBLIGATORIO |
ratio |
decimal | 8,2 | Rapporto di conversione Valuta/Attivita. Predefinito: 0 |
decimals |
char | Numero di cifre decimali. Opzioni: 0, 1, 2 o 3. Predefinito: 2. |
|
program_id |
string | 50 | Codice interno della campagna promozionale. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
program |
string | Nome campagna promozionale. OBBLIGATORIO | |
program_from |
date-time | Data di inizio campagna promozionale. Esempio: 2022-01-01 00:00:00. |
|
program_to |
date-time | Data di fine campagna promozionale. Esempio: 2022-12-31 23:59:59. |
|
program_deadline |
date-time | Data entro cui è possibile utilizzare il saldo. Esempio: 2023-02-28 23:59:59. |
|
card_number |
string | Numero card su cui effettuare la transazione. OBBLIGATORIO | |
operation |
string | Tipo di operazione da effettuare. Opzioni: plus, minus o equal. OBBLIGATORIO |
|
value |
decimal | 10,2 | Valore operazione. OBBLIGATORIO |
apply_ratio |
boolean | Nel caso di un operazione di carico effettua la conversione valore/attività (Es. Euro/Punti). Predefinito: false. |
|
note |
text | Note della transazione. | |
operation_date |
date-time | Data transazione. Esempio: 2022-03-12 16:30:20. |
|
show_errors |
boolean | Mostra il dettaglio degli errori. Predefinito: false. |
Esempio risposta JSON:
{
"loyalty_amounts":
{
"id":55555,
"id_app":88,
"id_company":44,
"id_app_customer":342,
"id_loyalty_type":7777,
"id_loyalty_program":666,
"amount":22.452,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
"loyalty_transactions":
{
"id":55555,
"id_app":88,
"id_company":44,
"id_user":,
"id_oauth_client":444,
"id_app_customer":342,
"id_loyalty_type":7777,
"id_loyalty_program":666,
"transaction_type":"+",
"transaction_value":22.452,
"operation_executed":"+22.452",
"note":"Carico punti",
"operation_date":"2022-03-12 16:30:20",
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
}
Saldi Cliente
Restituice l'elenco dei saldi di un cliente per ogni campagna attiva.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_customer_amounts
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"card_number": "XXXXXXXXXXXXX",
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
card_number |
string | Numero card su cui effettuare la transazione. OBBLIGATORIO |
Esempio risposta JSON:
{
"loyalty_amounts":
[{
"id_app":88,
"id_company":44,
....
}],
}
Coupons
Tramite questo set di chiamate è possibile gestire i coupon.
Gestione Coupon
Crea o aggiorna un coupon.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_coupon
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"coupon_id": "COU123",
"title": "Sconto 30%",
"subtitle": "Su tutta la collezione Autunno/Inverno",
"body": "Scegli tra oltre 600 capi di abbigliamneto uomo, donna e bambini e....",
"type": "percentage",
"value": 30,
"taxes": "included",
"available_from": "2022-01-01 00:00:00",
"available_to": "2022-12-31 23:59:59",
"coupon_deadline": "2023-02-28 23:59:59",
"customer_availability": 1,
"maximum_availability": 10,
"days_reset": 30,
"minimum_amount": 50,
"minimum_amount_tax": "included",
"minimum_amount_shipping": "included",
"specific_customers": true,
"type_id": "TYP123",
"program_id": "PRG123",
"loyalty_type_amount": 100
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
coupon_id |
string | Codice interno del coupon. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
|
title |
string | 100 | Nome visualizzato per identificare il coupon nel relativo elenco.OBBLIGATORIO |
subtitle |
string | 100 | Eventuale sottotitolo dove potrebbe essere necessario. |
body |
text | Eventuale descrizione del componente. | |
type |
string | Tipo sconto applicato Opzioni: percentage, currency o offer. Predefinito: percentage. |
|
value |
decimal | 10,2 | Valore coupon. OBBLIGATORIO |
taxes |
string | Tipo di tasse. Opzioni: excluded o included. Predefinito: excluded. |
|
available_from |
date-time | Data di inizio validità coupon. Esempio: 2022-01-01 00:00:00. |
|
available_to |
date-time | Data di fine validità coupon. Esempio: 2022-12-31 23:59:59. |
|
coupon_deadline |
date-time | Data entro cui è possibile utilizzare il coupon dopo l'ottenimento. Esempio: 2023-02-28 23:59:59. |
|
customer_availability |
integer | Numento utilizzi per singolo cliente.OBBLIGATORIO | |
maximum_availability |
integer | Numento utilizzi massimi totali del coupon. | |
days_reset |
integer | Numento di giorni entro cui gli utilizzi del coupon vengono azzerati. | |
minimum_amount |
decimal | 10,2 | Valore minimo di spesa per utilizzare il coupon. |
minimum_amount_tax |
string | Tipo di tasse del valore minimo. Opzioni: excluded o included. Predefinito: excluded. |
|
minimum_amount_shipping |
string | Sconto da applicare al totale incluso o escliso le spese di spedizione. Opzioni: excluded o included. Predefinito: excluded. |
|
specific_customers |
boolean | Associa il coupon solo a clienti specifici. Predefinito: false. |
|
type_id |
string | 50 | Codice interno del tipo di attività da cui decurtare il saldo per aggiudicarsi il coupon. Esempio: 32141, GF3D5GH. |
program_id |
string | 50 | Codice interno della campagna promozionale da cui decurtare il saldo per aggiudicarsi il coupon. Esempio: 32141, GF3D5GH. |
loyalty_type_amount |
decimal | 10,2 | Valore da decurtare dal saldo per aggiudicarsi il coupon. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_company":44,
"reference":"COU123",
"specific_customers":1,
"enabled":1,
"title":"Sconto 30%",
"subtitle":"Su tutta la collezione Autunno/Inverno",
"body":"Scegli tra oltre 600 capi di abbigliamneto uomo, donna e bambini e....",
"discount":30,
"discount_type":"percentage",
"discount_tax":"included",
"available_from":"2022-01-01 00:00:00",
"available_to":"2022-12-31 23:59:59",
"coupon_deadline":"2023-02-28 23:59:59",
"customer_availability":1,
"maximum_availability":10,
"days_reset":30,
"minimum_amount":50,
"minimum_amount_tax":"included",
"minimum_amount_shipping":"included",
"id_loyalty_type":7777,
"id_loyalty_program":9999,
"loyalty_type_amount":100,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Assegnazione Coupon
Associa un coupon ad un cliente.
Se il coupon ha il paramentro specific_customers impostato a true questa chiamata è superflua in quanto risulta associato a tutti.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_customer_coupons
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"card_number": "XXXXXXXXXXXXX",
"coupon_id": "COU123"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
card_number |
string | Numero card a cui associare il coupon. OBBLIGATORIO | |
coupon_id |
string | Codice interno del coupon. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"ean13":"XXXXXXXXXXXXX",
"id_app":88,
"id_company":44,
"id_coupon":778,
"id_app_customer":342,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Coupon Singolo Cliente
Crea ed associa un coupon ad un singolo cliente.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_coupon_single
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"coupon_id": "COU123",
"title": "Sconto 30%",
"subtitle": "Su tutta la collezione Autunno/Inverno",
"body": "Scegli tra oltre 600 capi di abbigliamneto uomo, donna e bambini e....",
"type": "percentage",
"value": 30,
"taxes": "included",
"available_from": "2022-01-01 00:00:00",
"available_to": "2022-12-31 23:59:59",
"coupon_deadline": "2023-02-28 23:59:59",
"customer_availability": 1,
"days_reset": 30,
"minimum_amount": 50,
"minimum_amount_tax": "included",
"minimum_amount_shipping": "included",
"specific_customers": true,
"card_number": "XXXXXXXXXXXXX",
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
coupon_id |
string | Codice interno del coupon. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
|
title |
string | 100 | Nome visualizzato per identificare il coupon nel relativo elenco.OBBLIGATORIO |
subtitle |
string | 100 | Eventuale sottotitolo dove potrebbe essere necessario. |
body |
text | Eventuale descrizione del componente. | |
type |
string | Tipo sconto applicato Opzioni: percentage, currency o offer. Predefinito: percentage. |
|
value |
decimal | 10,2 | Valore coupon. OBBLIGATORIO |
taxes |
string | Tipo di tasse. Opzioni: excluded o included. Predefinito: excluded. |
|
available_from |
date-time | Data di inizio validità coupon. Esempio: 2022-01-01 00:00:00. |
|
available_to |
date-time | Data di fine validità coupon. Esempio: 2022-12-31 23:59:59. |
|
coupon_deadline |
date-time | Data entro cui è possibile utilizzare il coupon dopo l'ottenimento. Esempio: 2023-02-28 23:59:59. |
|
customer_availability |
integer | Numento utilizzi per singolo cliente.OBBLIGATORIO | |
days_reset |
integer | Numento di giorni entro cui gli utilizzi del coupon vengono azzerati. | |
minimum_amount |
decimal | 10,2 | Valore minimo di spesa per utilizzare il coupon. |
minimum_amount_tax |
string | Tipo di tasse del valore minimo. Opzioni: excluded o included. Predefinito: excluded. |
|
minimum_amount_shipping |
string | Sconto da applicare al totale incluso o escliso le spese di spedizione. Opzioni: excluded o included. Predefinito: excluded. |
|
card_number |
string | Numero card a cui associare il coupon. OBBLIGATORIO |
Esempio risposta JSON:
{
"coupon":
{
"id":55555,
"id_app":88,
"id_company":44,
"reference":"COU123",
"specific_customers":1,
"enabled":1,
"title":"Sconto 30%",
"subtitle":"Su tutta la collezione Autunno/Inverno",
"body":"Scegli tra oltre 600 capi di abbigliamneto uomo, donna e bambini e....",
"discount":30,
"discount_type":"percentage",
"discount_tax":"included",
"available_from":"2022-01-01 00:00:00",
"available_to":"2022-12-31 23:59:59",
"coupon_deadline":"2023-02-28 23:59:59",
"customer_availability":1,
"maximum_availability":10,
"days_reset":30,
"minimum_amount":50,
"minimum_amount_tax":"included",
"minimum_amount_shipping":"included",
"id_loyalty_type":7777,
"id_loyalty_program":9999,
"loyalty_type_amount":100,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
"customer_coupon":
{
"ean13":"XXXXXXXXXXXXX",
"id_app":88,
"id_company":44,
"id_coupon":778,
"id_app_customer":342,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
}
Verifica Coupon
Effettua la verifica di un coupon tramite il codice scansionato in app.
Se il coupon non risulta valido oppure non è consentita la bruciatura viene restituito un errore.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/check_customer_coupon
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"coupon_number": "XXXXXXXXXXXXX"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
coupon_number |
string | Numero coupon da bruciare.OBBLIGATORIO |
Esempio risposta JSON:
{
"shops_coupons":
{
"id":55555,
"title":"Sconto 30%",
"subtitle":"Su tutta la collezione Autunno/Inverno",
"reference":"COU123",
"discount":30,
"discount_type":"percentage",
"discount_tax":"included",
"available_from":"2022-01-01 00:00:00",
"available_to":"2022-12-31 23:59:59",
"coupon_deadline":"2023-02-28 23:59:59",
"minimum_amount":50,
"minimum_amount_tax":"included",
"minimum_amount_shipping":"included",
"customer_availability":1,
"maximum_availability":1,
"total_burned":1,
"ean13":"XXXXXXXXXXXXX",
"id_app_customer":342,
"burned":1
}
}
Elenco Coupon Cliente
Restituisce tutti i coupon già ottenuti dal cliente.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_customer_coupons
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"card_number": "XXXXXXXXXXXXX",
"coupon_details": true
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
card_number |
string | Numero card del cliente. OBBLIGATORIO | |
coupon_details |
boolean | Mostra il dettaglio del coupon. Predefinito: false. |
Esempio risposta JSON:
{
"shops_coupons_customers":
[{
"ean13":"XXXXXXXXXXXXX",
"id_app":88,
"id_company":44,
"id_coupon":778,
"id_app_customer":342,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
{
"ean13":"XXXXXXXXXXXXX",
"id_app":88,
"id_company":44,
"id_coupon":778,
...
},
{
"ean13":"XXXXXXXXXXXXX",
"id_app":88,
"id_company":44,
"id_coupon":778,
...
}]
}
Brucia Coupon
Effettua la bruciatura di un coupon tramite il codice scansionato in app.
Se il coupon non risulta valido oppure non è consentita la bruciatura viene restituito un errore.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/burn_customer_coupon
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"coupon_number": "XXXXXXXXXXXXX"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
coupon_number |
string | Numero coupon da bruciare.OBBLIGATORIO |
Esempio risposta JSON:
{
"shops_coupons":
{
"id":55555,
"title":"Sconto 30%",
"subtitle":"Su tutta la collezione Autunno/Inverno",
"reference":"COU123",
"discount":30,
"discount_type":"percentage",
"discount_tax":"included",
"available_from":"2022-01-01 00:00:00",
"available_to":"2022-12-31 23:59:59",
"coupon_deadline":"2023-02-28 23:59:59",
"minimum_amount":50,
"minimum_amount_tax":"included",
"minimum_amount_shipping":"included",
"customer_availability":1,
"maximum_availability":1,
"total_burned":1,
"ean13":"XXXXXXXXXXXXX",
"id_app_customer":342,
"burned":1
}
}
Brucia Coupon Per Riferimento
Effettua la bruciature di un coupon per riferimento.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/burn_customer_coupon_reference
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"coupon_id": "COU123"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
coupon_id |
string | Codice interno del coupon. Esempio: 32141, GF3D5GH.OBBLIGATORIO |
Esempio risposta JSON:
{
"id":55555,
"title":"Sconto 30%",
"subtitle":"Su tutta la collezione Autunno/Inverno",
"reference":"COU123",
"discount":30,
"discount_type":"percentage",
"discount_tax":"included",
"available_from":"2022-01-01 00:00:00",
"available_to":"2022-12-31 23:59:59",
"coupon_deadline":"2023-02-28 23:59:59",
"minimum_amount":50,
"minimum_amount_tax":"included",
"minimum_amount_shipping":"included",
"customer_availability":1,
"maximum_availability":1,
"total_burned":1,
"ean13":"XXXXXXXXXXXXX",
"id_app_customer":342,
"burned":1
},
Posta
Tramite questo set di chiamate è possibile gestire la posta in arrivo.
Download messaggi di posta
Scarica tutti i nuovi messaggi di posta non letti.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_inboxes
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO |
Esempio risposta JSON:
[{
"id":55555,
"id_app":88,
"id_app_form":44,
"id_company":"66",
"id_device":546546,
"id_app_customer":213211,
"form_data":"[{"number": ["Persone", "5"]}, {"datetime": ["Data e Ora.....",
"state":0,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
},
....
]
Cambio stato messaggi di posta
Imposta un messaggio da leggere o letto.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/set_inboxes_state
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"inbox_id":2113213,
"state": 1
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
inbox_id |
string | Identificativo del messaggio. | |
state |
boolean | Stato del messaggio letto (true) oppute non letto (false). Opzioni: true, false. |
Esempio risposta JSON:
{
"id":55555,
"id_app":88,
"id_app_form":44,
"id_company":"66",
"id_device":546546,
"id_app_customer":213211,
"form_data":"[{"number": ["Persone", "5"]}, {"datetime": ["Data e Ora.....",
"state":0,
"created_at":"2022-03-30 15:03:04",
"updated_at":"2022-04-03 12:38:26"
}
Clienti
Tramite questo set di chiamate è possibile esportare l'archivio dei clienti.
Elenco clienti
Restituisce l'elenco dei clienti registrati tramite app.
La chiamata restituisce al massimo 10 clienti.
Tramite un meccanismo di paginazione dei risultati è possibile ottenete i clienti della pagina 1, 2, 3, ecc...
I risultati saranno ordinati per data di modifica.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_customers
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"page": 1,
"updated_at": "2022-04-03 12:38:26",
"search": ""
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
page |
integer | Numero di pagina. Esempio: 1, 2. Predefinito: 1. |
|
updated_at |
date-time | Data di creazione o aggiornamento del cliente. | |
search |
string | Se valorizzato esporta unicamente i clienti che sono coerenti con la stringa specificata. Se si passa il valore Mario Rossi otterremo tutti i clienti con quel nominativo. |
Esempio risposta JSON:
[{
"id":55555,
"id_app":88,
"id_company":"66",
"gender":"Uomo",
"name":"Mario",
"surname":"Rossi",
"birth_data":"1967-05-24",
"reference":"",
"address":"Via Roma",
"zip_code":"12345",
"city":"Roma",
"province":"RM",
"state":"IT",
"phone":"123456789",
"mobile":"123456789",
"fax":"123456789",
"email":"mariorossi@cmh.it",
"enabled":1,
"created_at":"2018-10-10 09:57:15",
"updated_at":"2018-10-10 09:57:15",
"qrcode":"XXXXX...",
"ean13":XXXXX....",
"ecn":"XXXXXX"
},
....
]
Elenco dispositivi
Restituisce l'elenco dei dispositivi che utilizzano l'app.
La differenza rispetto all'esportazione dei clienti consiste nel fatto che un dispositivo può non avere un cliente associato per diversi motivazioni. La più comune è quella in cui l'app viene scaricata ma non si effettua la registrazione.
La chiamata restituisce al massimo 100 dispositivi.
Tramite un meccanismo di paginazione dei risultati è possibile ottenete i clienti della pagina 1, 2, 3, ecc...
I risultati saranno ordinati per data di modifica.
URL HTTPS
POST
https://backend.easyappear.it/rest_api/get_devices
Parametri JSON
{
"token_key": "YOUR_APP_TOKEN_KEY",
"client_id": "YOUR_CLIENT_ID",
"page": 1,
"updated_at": "2022-04-03 12:38:26"
}
Parametri
| Parametro | Tipo | Lunghezza | Descrizione |
|---|---|---|---|
token_key |
string | 40 | Token identificativo dell'app. Viene fornito alla creazione di una nuova App. OBBLIGATORIO |
client_id |
string | Codice cliente API fornito assieme al Codice segreto. OBBLIGATORIO | |
page |
integer | Numero di pagina. Esempio: 1, 2. Predefinito: 1. |
|
updated_at |
datetime | Data di creazione o aggiornamento del dispositivo. |
Esempio risposta JSON:
[{
"id":55555,
"id_app":88,
"id_company":"66",
"id_app_customer":,
"restrict_to_customer":,
"uid_device":"123456-YYYY-XXXXXXXXXXXXXXX",
"token_notification":,
"token_device":"XXXXX",
"device_model":"SM-XXXXX",
"platform":"Android",
"platform_version":"10",
"last_activity":"2021-04-06 11:19:36",
"last_coordinates":"41.89023599891259,12.492255874088963",
....
},
....
]