Application which helps you organize your shopping lists. Every item may have a category to which it belongs. Every list may have a layout which represents order of categories in your shop. So you first define layout (order of categories) of your shop and then you add this layout to a list. After that, items of the list will be respecting the order of the layout.
endpoint: https://sange-icinga.hukot.net:8443
Used technologies/assets:
Application combines two APIs:
- google sheet API for retrieving categories from public google spreadsheet
- Parse API which is used for backing database and user management
and it provides own API, listed methods below, written in NodeJS
These headers are necessary for consuming Parse API. App sends them on behalf of the client, except X-Parse-Session-Token.
| Key | Value |
|---|---|
| X-Parse-REST-API-Key | 3kN0dGXh5X7dMCXk1UmmgWNUZrtG6hyFVdiv6OxV |
| X-Parse-Application-Id | PKeL1iyUnVnfayP2g99XelQRGFQbpWE3P9DASAo6 |
| X-Parse-Session-Token | from_login_response |
URL prefix: 'https://sange-icinga.hukot.net:8443/api/1.0'
Test API with Postman, get shared LINK.
| HTTP Method | URL | Operation | Required params |
|---|---|---|---|
| POST | /register | register new user (requires email verification) | username, email, password |
| POST | /login | login user | username, password |
| GET | /category | list categories | |
| POST | /list | create list at given position of your lists | name, position, layout_id, ACL, crossed |
| GET | /list | list lists | |
| GET | /list/id | retrieve list with given id | |
| PUT | /list/id | update any list's parameter | |
| PUT | /listUpdatePositions | update lists position | objectIds, positions |
| DELETE | /list/id | delete list with given id | |
| DELETE | /listDeleteCrossed | delete crossed lists | objectIds |
| POST | /layout | create layout at given position of your layouts | name, position, categories, ACL, crossed |
| GET | /layout | list layouts | |
| GET | /layout/id | retrieve layout with given id | |
| PUT | /layout/id | update any layout's parameter | |
| PUT | /layoutUpdatePositions | update layouts position | objectIds, positions |
| DELETE | /layout/id | delete layout with given id | |
| DELETE | /layoutDeleteCrossed | delete crossed layouts | objectIds |
| POST | /item | create item | name, category, list_id, ACL, crossed |
| GET | /item | list items | |
| GET | /itemForList/list_id | list items for given list_id | |
| GET | /item/id | retrieve item with given id | |
| PUT | /item/id | update item | |
| DELETE | /item/id | delete item with given id | |
| DELETE | /itemDeleteCrossed | delete crossed items | objectIds |
- All methods except the first three require passing session token named "token" from /login or /register request as a header: "token".
- all POST methods accept parameters in body (raw).
- successful registration requires email verification (=click on received link in registration email)
- all requests and responses are in JSON, see examples below
- position: lower number, higher position
- list_id, layout_id: object id reference to list resp. layout, when you want to unset this reference, use for example:
layout_id.objectId = null;. - with ACL you can control access rights to an object, use userId returned from login/register
- GET and DELETE (except deleting crossed) requests do not contain body, so request is not listed with these methods.
- DELETE response is empty object.
{
"username":"myname",
"password":"mypass",
"email":"email@email.com"
}
{
"token": "r:NTgtL2..........Ko2skCv",
"userId": "NTgtL2....KoCv"
}
{
"username":"myname",
"password":"mypass",
}
{
"token": "r:NTgtL2..........Ko2skCv",
"userId": "NTgtL2....KoCv"
}
[
{
"desc": "uncatogorized",
"name": "uncatogorized",
"id": "0"
},
...
{
"desc": "baby items, pet items, batteries, greeting cards",
"name": "Other",
"id": "12"
}
]
{
"name":"list 2342",
"desc":"",
"position": 7,
"layout_id": {
"__type": "Pointer",
"className": "layouts",
"objectId": "as....sd"
},
"ACL":{
"vX.....N": {
"read": true,
"write": true
}
},
"crossed": false
}
{
"createdAt": "2016-01-10T22:17:21.216Z",
"objectId": "Gq....q2"
}
{
"results": [
{
"ACL": {
"vX8......8N": {
"read": true,
"write": true
}
},
"createdAt": "2015-12-30T12:08:27.655Z",
"layout_id": {
"__type": "Pointer",
"className": "layouts",
"objectId": "qcD......CT"
},
"name": "listX",
"objectId": "rXX.....cb",
"position": 1,
"updatedAt": "2016-01-07T12:26:44.853Z",
"crossed": false
}
]
}
Same as GET /list except it returns only one object (or error).
{
"name":"list xxx",
"desc":"",
"position":1,
"layout_id": {
"__type": "Pointer",
"className": "layouts",
"objectId": "null"
},
"ACL":{
"vX.....N": {
"read": true,
"write": true
}
},
"crossed": false
}
{
"updatedAt": "2016-01-10T22:20:45.416Z"
}
{
[
{
"objectId": "gs......s",
"position": 4
},
...
{
"objectId": "gt......s",
"position": 6
}
]
}
Returns all updated lists.
{
"results": [ ... ]
}
{
[
{
"objectId": "gs......s",
},
...
{
"objectId": "gt......s",
}
]
}
{
"name":"layout 1",
"desc":"",
"position": 7,
"categories": [7, 8, 0],
"ACL":{
"vX.....N": {
"read": true,
"write": true
}
},
"crossed": false
}
{
"createdAt": "2016-01-10T22:17:21.216Z",
"objectId": "Gq....q2"
}
{
"results": [
{
"ACL": {
"vX8......8N": {
"read": true,
"write": true
}
},
"createdAt": "2015-12-30T12:08:27.655Z",
"categories": [1, 2, 1, 4, 0],
"name": "listX",
"objectId": "rXX.....cb",
"position": 1,
"updatedAt": "2016-01-07T12:26:44.853Z",
"crossed": false
},
.....
{
....
}
]
}
Same as GET /layout except it returns only one object (or error).
{
"name":"layout 2",
"desc":"",
"position": 3,
"categories": [0, 9, 7],
"ACL":{
"vX.....N": {
"read": true,
"write": true
}
},
"crossed": false
}
{
"updatedAt": "2016-01-10T22:20:45.416Z"
}
{
[
{
"objectId": "gs......s",
"position": 4
},
...
{
"objectId": "gt......s",
"position": 6
}
]
}
Returns all updated layouts.
{
"results": [ ... ]
}
{
[
{
"objectId": "gs......s",
},
...
{
"objectId": "gt......s",
}
]
}
{
"name":"item 3",
"desc":"",
"category": 2,
"list_id": {
"__type": "Pointer",
"className": "lists",
"objectId": "as....sd"
},
"ACL":{
"vX85j2mq8N": {
"read": true,
"write": true
}
},
"crossed": false
}
{
"createdAt": "2016-01-10T22:17:21.216Z",
"objectId": "Gq....q2"
}
{
"results": [
{
"ACL": {
"vX......": {
"read": true,
"write": true
}
},
"category": 0,
"createdAt": "2015-12-30T14:27:03.891Z",
"desc": "",
"list_id": {
"__type": "Pointer",
"className": "lists",
"objectId": "rX.....cb"
},
"name": "itemmmmm",
"objectId": "3....V",
"updatedAt": "2016-01-06T10:58:52.639Z",
"crossed": false
},
.....
{
....
}
]
}
Same as GET /item except it returns only one object (or error).
#####request:
{
"name":"item 3",
"desc":"",
"category": 2,
"list_id": {
"__type": "Pointer",
"className": "lists",
"objectId": "as....sd"
},
"ACL":{
"vX85j2mq8N": {
"read": true,
"write": true
}
},
"crossed": false
}
{
"updatedAt": "2016-01-10T22:20:45.416Z"
}
{
[
{
"objectId": "gs......s",
},
...
{
"objectId": "gt......s",
}
]
}
With appropriate HTTP status code
{
"err": "Message to specify what went wrong."
}