README

所有对API的调用都将以/api/v1/开头
所有响应都将使用JSON格式
如果响应状态码不是200，JSON将包含一个包含code和message元素的数组

登录

• URL: /api/v1/login
• 方法: ANY
• 参数: username, password 或 token
• 响应: token
  所有后续请求都需要该token。

示例: /api/v1/login?username=3333334444&password=fake
示例返回: {"data":{"token":"12d3ff","user":{"id":2,"username":"3333334444","name":"Beau Lynn-Miller","phone":"3333334444","email":"beaulm@gmail.com","created_at":"2014-10-17 10:16:58","updated_at":"2014-10-17 10:17:00","deleted_at":null,"last_offered":null}},"timestamp":"2014-10-17 10:57:05","hashes":{"gpsConfig":"422962d8","vehicles":"86e45d7c","towingCompanies":"011500b9","states":"738ee935"}}

获取全部

• URL: /api/v1/{object}
• 方法: GET
• 参数: token
• 响应: 对象数据数组

示例: /api/v1/user?token=12d3ff
示例返回: [{"id":1,"name":"Fakey McFakerson","email":"fake@fake.com"},{"id":2,"name":"Foo McBarenson","email":"foo@bar.com"}]

获取特定

• URL: /api/v1/{object}/{id}
• 方法: GET
• 参数: token
• 响应: 对象数据

示例: /api/v1/user/2?token=12d3ff
示例返回: {"id":2,"name":"Foo McBarenson","email":"foo@bar.com"}

创建对象

• URL: /api/v1/{object}
• 方法: POST
• 参数: token，模型中定义的可填充参数
• 响应: 对象数据

示例: /api/v1/user?name=Testey&password=test&email=test@test.com&phone=5551234123&token=12d3ff
示例返回: {"id":3,"name":"Testey","email":"test@test.com","phone":"5551234123"}

更新对象

• URL: /api/v1/{object}/{id}
• 方法: PUT
• 参数: token，模型中定义的可填充参数
• 响应: 对象数据

示例: /api/v1/user/2?phone=5557777777&token=12d3ff
示例返回: {"id":2,"name":"Foo McBarenson","email":"foo@bar.com","phone":"5557777777"}

删除对象

• URL: /api/v1/{object}/{id}
• 方法: DELETE
• 参数: token
• 响应: 剩余对象数组

示例: /api/v1/user/1
示例返回: [{"id":2,"name":"Foo McBarenson","email":"foo@bar.com","phone":"5557777777"},{"id":3,"name":"Testey","email":"test@test.com","phone":"5551234123"}]

登出

• URL: /api/v1/logout
• 方法: ANY
• 参数: token
• 响应: 包含消息的JSON

示例: /api/v1/logout?token=12d3ff
示例返回: {"message":"Logout successful"}

错误

在没有token的情况下进行调用将导致错误

示例: /api/v1/user
示例返回: {"code":401,"message":"您没有权限查看此网页"}