goodsdb-api

About authentication

To authenticate, the request should contain the following header:

X-Token: USER_TOKEN

The token is received on login.

Items

GET /items

Request

• Needs authentication: yes

Response

• Content-Type: application/json
• Status: 200

[
    {
        "id": 1,
        "name": "the-name",
        "liked": true,
        "likesCount": 1,
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00",
        "tags": [{
            "id": 1,
            "name": "tag-1",
            "createdAt": "2014-12-13T14:49:15+09:00",
            "updatedAt": "2014-12-13T14:49:15+09:00"
        }, {
            "id": 2,
            "name": "tag-2",
            "createdAt": "2014-12-13T14:49:15+09:00",
            "updatedAt": "2014-12-13T14:49:15+09:00"
        }],
        "pictures": [{
            "id": 1,
            "imageUrl": "http://mysuperserver/mysuperimage.jp",
            "createdAt": "2014-12-13T14:49:15+09:00",
            "updatedAt": "2014-12-13T14:49:15+09:00"
        }, {
            "id": 2,
            "imageUrl": "http://mysuperserver/mysuperimage2.jp",
            "createdAt": "2014-12-13T14:49:15+09:00",
            "updatedAt": "2014-12-13T14:49:15+09:00"
        }]
    }
]

POST /items

Request

• Needs authentication: yes
• Content-Type: multipart/form-data

item[name] = "the-name"
item[tags][] = "tag-1"
item[tags][] = "tag-2"
item[pictures][] = FILE_1_CONTENT
item[pictures][] = FILE_2_CONTENT

Android sample:

MultipartEntity data = new MultipartEntity(HttpMultipartMode.BROWSER_COMPATIBLE);
data.addPart("item[name]", new StringBody("the-name"));
data.addPart("item[tags][]", new StringBody("tag-1"));
data.addPart("item[tags][]", new StringBody("tag-2"));
data.addPart("item[pictures][]", new FileBody(new File("gimmethatfile.jpg")));
data.addPart("item[pictures][]", new FileBody(new File("gimmethatfile2.jpg")));

Response

• Content-Type: application/json
• Status: 201

{
    "id": 1,
    "name": "the-name",
    "liked": false,
    "likesCount": 0,
    "createdAt": "2014-12-13T14:49:15+09:00",
    "updatedAt": "2014-12-13T14:49:15+09:00",
    "tags": [{
        "id": 1,
        "name": "tag-1",
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00"
    }, {
        "id": 2,
        "name": "tag-2",
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00"
    }],
    "pictures": [{
        "id": 1,
        "imageUrl": "http://mysuperserver/gimmethatfile.jp",
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00"
    }, {
        "id": 2,
        "imageUrl": "http://mysuperserver/gimmethatfile2.jp",
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00"
    }]
}

PUT /items/:id

Request

• Needs authentication
• Content-Type: application/json

{
    "item": {
        "name": "new name",
        "tags": ["tag-1", "tag-3"]
    }
}

Response

• Content-Type: application/json
• Status: 200

{
    "id": 1,
    "name": "new name",
    "liked": true,
    "likesCount": 1,
    "createdAt": "2014-12-13T14:49:15+09:00",
    "updatedAt": "2014-12-13T14:49:15+09:00",
    "tags": [{
        "id": 1,
        "name": "tag-1",
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00"
    }, {
        "id": 3,
        "name": "tag-3",
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00"
    }],
    "pictures": [{
        "id": 1,
        "imageUrl": "http://mysuperserver/gimmethatfile.jp",
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00"
    }, {
        "id": 2,
        "imageUrl": "http://mysuperserver/gimmethatfile2.jp",
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00"
    }]
}

DELETE /items/:id

Request

• Needs authentication: yes

Response

• Status: 200

{
    "success": true
}

POST /items/:id/add_event

Use when item is lost or found.

Request

• Needs authentication: yes
• Content-Type: application/json

Response

• Content-Type: application/json
• Status: 201

{
   "id": 9,
   "status": 3,
   "item_id": 1,
   "created_at": "2014-12-13T11:33:19.759Z",
   "updated_at": "2014-12-13T11:33:37.493Z"
}

GET /items/search

Search for items by tags and status.

Request

• Needs authentication: yes
• Query parameters:
  • tags[]: Tags to search for. Required: true
  • type: Item status (lost|found|lost_and_found). Required: false, default: found

Example request:

GET /items/search?tags[]=bar&tags[]=foo&type=lost

Response

• Content-Type: application/json
• Status: 200

[
    {
        "id": 1,
        "name": "the-name",
        "liked": true,
        "likesCount": 1,
        "createdAt": "2014-12-13T14:49:15+09:00",
        "updatedAt": "2014-12-13T14:49:15+09:00",
        "tags": [{
            "id": 1,
            "name": "tag-1",
            "createdAt": "2014-12-13T14:49:15+09:00",
            "updatedAt": "2014-12-13T14:49:15+09:00"
        }, {
            "id": 2,
            "name": "tag-2",
            "createdAt": "2014-12-13T14:49:15+09:00",
            "updatedAt": "2014-12-13T14:49:15+09:00"
        }],
        "pictures": [{
            "id": 1,
            "imageUrl": "http://mysuperserver/mysuperimage.jp",
            "createdAt": "2014-12-13T14:49:15+09:00",
            "updatedAt": "2014-12-13T14:49:15+09:00"
        }, {
            "id": 2,
            "imageUrl": "http://mysuperserver/mysuperimage2.jp",
            "createdAt": "2014-12-13T14:49:15+09:00",
            "updatedAt": "2014-12-13T14:49:15+09:00"
        }]
    }
]

POST /items/:id/like

• Needs authentication: yes

Response

• Content-Type: application/json
• Status: 204

{
    "success": true
}

DELETE /items/:id/like

• Needs authentication: yes

Response

• Content-Type: application/json
• Status: 200

{
    "success": true
}

Authentication

POST /login

Request

• Needs authentication: no
• Content-Type: application/json

{
    "facebook_id": "67123214",
    "facebook_token": "jkwqejh71y273h21uehwje1237wheqwjhe217312"
}

Response

• Content-Type: application/json
• Status: 200 on success, 401 on not authorized

{
    "id": 1,
    "first_name": "first name",
    "last_name": "last name",
    "display_name": "display name",
    "profile_picture": "https://www.facebook.com/mypicture.jpg",
    "token": "jkwqejh71y273h21uehwje1237wheqwjhe217312",
    "created_at": "2014-12-13T14:49:15+09:00",
    "updated_at": "2014-12-13T14:49:15+09:00"
}