==============================
Nota: la rotta è configurabile nel file di configurazione di ngxBackend.
POST /api/login
{
"username": "pippo",
"password": "pippo",
"remember": true
}##### Risposta 200 OK
{
"id": "<my_access_token>",
"userId": 1,
"user": {
"username": "pippo",
"email": "pippo@gmail.com"
}
}Il campo id nella risposta conterrà l'Access Token necessario per utilizzare le chiamate autenticate.
ngxBackend passerà questo valore ad ogni chiamata nel campo access_token (sempre in querystring).
Esempio:
GET /api/products ? access_token = xcZaWOL...
--
Nota: la rotta è configurabile nel file di configurazione di ngxBackend.
GET /api/setup
Questa chiamata restituisce l'intera configurazione delle pagine del pannello.
Fare riferimento al seguente URL per la struttura:
https://github.com/MrAPPs-RSM/ngx-backend/wiki/pages
{
"contentLanguages": [
{
"id": 1,
"name": "Italiano",
"isoCode": "it",
"isDefault": true
}
],
"pages": [
{
"path": "profile",
"type": "profile",
"params": {
"menu": {
"title": "Profile",
"sidebar": false,
"breadcrumbLevel": 1
}
}
},
{
"path": "products/list",
"type": "table",
"params": {
"isHomePage": true,
"menu": {
"title": "Prodotti",
"sidebar": true,
"icon": "fa fa-apple",
"order": 1,
"breadcrumbLevel": 1
},
"tables": [
{
"api": {
"endpoint": "products",
"filter": "{\"where\":{\"category\":\"product\"}}"
},
"noDataMessage": "Nessun prodotto trovato",
"actions": {
"columnTitle": "Azioni",
"add": {
"name": "Aggiungi",
"content": "<i class=\"fa fa-plus\"></i>",
"class": "success",
"config": {
"path": "products/create"
}
},
"list": [
{
"name": "Modifica",
"content": "<i class=\"fa fa-edit\"></i>",
"class": "warning",
"config": {
"path": "products/edit/:id/:title",
"titleField": "name"
}
},
{
"name": "Elimina",
"content": "<i class=\"fa fa-trash\"></i>",
"class": "danger",
"config": {
"endpoint": "products/:id",
"method": "delete",
"confirm": true
}
}
]
},
"columns": {
"id": {
"title": "ID",
"type": "number"
},
"name": {
"title": "Nome",
"type": "string"
},
"image_url": {
"title": "Immagine",
"type": "image",
"filter": false
},
"cost": {
"title": "Prezzo",
"type": "number"
},
"category": {
"title": "Categoria",
"type": "string"
}
},
"pager": {
"perPage": 20
}
}
]
}
},
{
"path": "products/create",
"type": "form",
"params": {
"menu": {
"title": "Nuovo prodotto",
"breadcrumbLevel": 2,
"sidebar": false
},
"forms": [
{
"api": {
"endpoint": "products"
},
"submit": {
"confirm": false,
"redirectAfter": "products/list"
},
"fields": {
"base": [
{
"key": "name",
"type": "text",
"label": "Nome",
"validators": {
"required": true
}
},
{
"key": "image_id",
"type": "file",
"label": "Immagine",
"options": {
"api": {
"upload": "images/upload"
},
"allowedContentTypes": [
".png",
".jpg",
".jpeg",
".gif"
]
},
"validators": {
"required": true
}
},
{
"key": "cost",
"type": "number",
"label": "Prezzo",
"validators": {
"required": true
}
},
{
"key": "desc",
"type": "textarea",
"label": "Descrizione",
"options": {
"editor": false
},
"validators": {
"required": false
}
}
]
}
}
]
}
},
{
"path": "products/edit/:id/:title",
"type": "form",
"params": {
"menu": {
"title": "",
"breadcrumbLevel": 2,
"sidebar": false
},
"forms": [
{
"isEdit": true,
"api": {
"endpoint": "products"
},
"submit": {
"label": "Salva",
"confirm": false,
"redirectAfter": "products/list"
},
"fields": {
"base": [
{
"key": "name",
"type": "text",
"label": "Nome",
"validators": {
"required": true
}
},
{
"key": "image_id",
"type": "file",
"label": "Immagine",
"options": {
"api": {
"upload": "images/upload"
},
"allowedContentTypes": [
".png",
".jpg",
".jpeg",
".gif"
]
},
"validators": {
"required": true
}
},
{
"key": "cost",
"type": "number",
"label": "Prezzo",
"validators": {
"required": true
}
},
{
"key": "desc",
"type": "textarea",
"label": "Descrizione",
"options": {
"editor": false
},
"validators": {
"required": false
}
}
]
}
}
]
}
}
]
}Elenco di entità da mostrare in tabella (paginata).
La rotta è configurabile nella chiamata setup per ogni entity.
GET /api/<entity>
GET /api/products
{
"where": {
"and": [
{
"name": {
"like": "%penna%"
}
},
{
"inserted_at": {
"between": [
"2019-01-11T23:00:00.000Z",
"2019-01-21T23:00:00.000Z"
]
}
},
{
"enabled": true
}
]
},
"order": "id ASC",
"skip": 0,
"limit": 10
}##### Risposta 200 OK
[
{
"id": 1,
"name": "Penna Bic",
"image_url": "https://www.retif.it/media/image/400x/penna-bic-cristal-blu-pack-da-50_01.jpg",
"cost": 1,
"category": "product"
},
{
"id": 2,
"name": "Temperamatite",
"image_url": "https://www.retif.it/media/image/400x/penna-bic-cristal-blu-pack-da-50_01.jpg",
"cost": 1.6,
"category": "product"
}
]--
Conteggio totale delle entità da mostrare in tabella, necessario per il paginatore.
La rotta deve corrispondere alla rotta list corrispondente, aggiungendo il suffisso /count.
GET /api/<entity>/count
GET /api/products/count
Il body di richiesta della chiamata count è lo stesso della chiamata list, ad esclusione dei parametri order, skip e limit.
{
"where": {
"and": [
{
"name": {
"like": "%penna%"
}
},
{
"inserted_at": {
"between": [
"2019-01-11T23:00:00.000Z",
"2019-01-21T23:00:00.000Z"
]
}
},
{
"enabled": true
}
]
}
}##### Risposta 200 OK
{
"count": 150
}--
Eliminazione di un singolo oggetto.
La rotta è configurabile nella chiamata setup per ogni entity.
DELETE /api/<entity>/<id>
DELETE /api/products/1
##### Risposta 200 OK
{
"success": true
}--
Ordinamento degli elementi in tabella.
La rotta deve corrispondere alla rotta list corrispondente, aggiungendo il suffisso /sort.
PATCH /api/<entity>/sort
PATCH /api/products/sort
Nella richiesta viene passata la situazione aggiornata (come appare in tabella dopo l'azione di drag) e i dati del paginatore (numero di pagina e numero di elementi per pagina).
{
"data": [
{
"id": 3,
[...]
},
{
"id": 1,
[...]
},
{
"id": 2,
[...]
},
[...]
],
"page": 1,
"perPage": 25
}##### Risposta 200 OK
{
"success": true
}Elenco completo dei campi da mostrare nel form (editabili e non) per un singolo oggetto.
La rotta è configurabile nella chiamata setup per ogni entity.
GET /api/<entity>/<id>
GET /api/products/1
##### Risposta 200 OK
{
"id": 1,
"name": "Penna Bic",
"image_url": "https://www.retif.it/media/image/400x/penna-bic-cristal-blu-pack-da-50_01.jpg",
"desc": "test",
"cost": 1,
"shipping_fees": 0,
"inserted_at": "2019-02-01T23:00:00.000Z",
"updated_at": "2019-02-01T23:00:00.000Z",
"category": "product"
}--
Inserimento di un nuovo oggetto.
La rotta è configurabile nella chiamata setup per ogni entity.
PUT /api/<entity>
PUT /api/products
{
"name": "iPad Pro",
"image_id": 5,
"desc": "test",
"cost": 899
}##### Risposta 200 OK
{
"id": 3,
"name": "iPad Pro",
"image_url": "https://www.retif.it/media/image/400x/penna-bic-cristal-blu-pack-da-50_01.jpg",
"desc": "test",
"cost": 899,
"shipping_fees": 0,
"inserted_at": "2019-02-04T15:30:00.000Z",
"updated_at": "2019-02-04T15:30:00.000Z",
"category": "product"
}--
Modifica dei dati di un oggetto esistente.
La rotta è configurabile nella chiamata setup per ogni entity.
PATCH /api/<entity>/<id>
PATCH /api/products/3
{
"name": "iPad Pro 12 pollici",
"image_id": 5,
"desc": "modificata",
"cost": 999
}##### Risposta 200 OK
{
"id": 3,
"name": "iPad Pro 12 pollici",
"image_url": "https://www.retif.it/media/image/400x/penna-bic-cristal-blu-pack-da-50_01.jpg",
"desc": "modificata",
"cost": 999,
"shipping_fees": 0,
"inserted_at": "2019-02-04T15:30:00.000Z",
"updated_at": "2019-02-04T18:00:00.000Z",
"category": "product"
}Lista di elementi dinamici per un determinato componente HTML Select.
La rotta è configurabile nella chiamata setup per ogni Select.
GET /api/<entity>/select/options
GET /api/products/select/options
{
"search": "ipad"
}##### Risposta 200 OK
[
{
"id": 3,
"text": "iPad Pro"
},
{
"id": 7,
"text": "iPad 2018"
}
]--
Upload di un file.
La rotta è configurabile nella chiamata setup per ogni componente File Input.
POST /api/upload/file
{
"file": <binary>
}
##### Risposta 200 OK
Prevedere una tabella dove salvare i dati relativi ai files uploadati.
{
"id": 1510,
"type": "image/png",
"normalizedType": "image",
"url": "https://www.retif.it/media/image/400x/penna-bic-cristal-blu-pack-da-50_01.jpg",
"name": "penna-bic-cristal-blu-pack-da-50_01.jpg"
}##### Risposta standard
In caso di errore rispondere con la seguente struttura.
{
"error": {
"statusCode": 400,
"message": "Oops! An Error occurred.",
"code": "BAD_REQUEST"
}
}| code | statusCode |
|---|---|
| BAD_REQUEST | 400 |
| UNAUTHORIZED | 401 |
| FORBIDDEN | 403 |
| NOT_FOUND | 404 |
| INTERNAL_SERVER_ERROR | 500 |