- response status code:
- 200: ok
- 400: incorrect request
- 500: Internal Server Error (bug)
-
POST
/api/user/login
-
request
{ "email": "", "password": "" }
-
session be set if succeeded
- GET
/api/user/logout
-
POST
/api/user
-
request:
-
{ "userEmail": "", "userPass": "", "comName": "", "comCode": "", "comCapital": "", "comTime": "", "comPerson": "", "comEmail": "", "comPhone": "", "comManager": "", "comRegistAddresss": "", "comWorkAddresss": "", "comField": "", "comProduct": "", "comIntro": "", "contactName": "", "contactJob": "", "contactMobile": "", "contactEmail": "", "contactQQ": "", "contactPhone": "" }
- PUT
/api/user/self
- request: the same as
regist
(exceptuserEmail
, which is immutable), only provided fields will be edited.
- GET
/api/user/self
- response: the same as
regist
exceptuserPass
-
GET
/api/user/:id
-
response:
-
if you are friends:
-
{ "_id": "", "comName": "阿里巴巴", "comCode": "1", "comCapital": "1", "comTime": "1", "comPerson": "1", "comEmail": "1", "comPhone": "1", "comManager": "1", "comRegistAddresss": "1", "comWorkAddresss": "1", "comField": "1", "comProduct": "1", "comIntro": "1", "contactName": "1", "contactJob": "1", "contactMobile": "1", "contactEmail": "1", "contactQQ": "1", "contactPhone": "1", "isFriend": true }
-
if not friends:
-
{ "_id": "", "comName": "", "comTime": "", "comRegistAddresss": "", "comWorkAddresss": "", "comField": "", "comProduct": "", "comIntro": "", "comPhone": "" }
- GET
/api/user/search?q=QUERY
- response:
[{BASIC INFO}]
- GET
/api/friend/list
- response:
[{DETAIL(same as get-self-info)}]
- DELETE
/api/friend/:friendId
- note: friendId given in the
_id
field in api responses
- POST
/api/friend/request?to=id
-
GET
/api/message/friend?size=SIZE&page=PAGE
-
response:
-
[ { "_id": "", // message-id "from": { "_id": "", // sender-id "comName": "阿里巴巴", "comCapital": "900万元", "comTime": "1990.09.09", "comPhone": "0212-8989821", "comRegistAddresss": "", "comWorkAddresss": "", "comField": "", "comProduct": "", "comIntro": "" }, "type": "FriendRequest-Received", "info": { "request": "599c2bfd8404c83370943d4e" // request-id }, "__v": 0, "date": "2017-08-22T13:05:01.503Z", "read": false } ]
-
example: GET
/api/message/friend?size=5&page=0
-
message types:
-
[ 'FriendRequest-Received', // when received a request 'FriendRequest-Received&Accepted', // when received & accepted a request 'FriendRequest-Received&Refused', // when received & refused a request 'FriendRequest-Accepted', // when a request one sent is accepted 'FriendRequest-Refused' // when a request one sent is refused ]
-
-
GET
/api/message?size=SIZE&page=PAGE
-
response: TO-BE-DONE
- POST
/api/friend/accept/:messageId
- POST
/api/friend/refuse/:messageId
###publish Lend
-
POST
/api/loan/lend
-
{ "max_amount": 1, "loan_ddl": 12 }
-
POST
/api/loan/borrow
-
{ "city": "", "project": "", "max_amount": 1, "reason": "", "max_rate": 3, "loan_ddl": 12, "other_detail": "" }
-
GET
/api/loan/borrow
-
[ { "_id": "59a41435b80d0d38a465c2a3", "city": "广州1", "project": "smart_PL1", "max_amount": 10, "reason": "吃喝嫖赌", "max_rate": 4.3, "loan_ddl": 6, "other_detail": "我要钱", "from": "599fe35e6e76741bf0b321cd", "__v": 0, "date": "2017-08-28T13:01:41.112Z" } ]
-
GET
/api/loan/lend
-
[ { "_id": "59a410a4599bfd1ae8c872fc", "max_amount": 30, "loan_ddl": 12, "from": "59a3bc193cde380b1cef10a5", "__v": 0, "date": "2017-08-28T12:46:28.484Z" } ]
-
GET
/api/loan/detail/borrow?id=BORROWID
-
{ "_id": "59a56a1d42e9f105809ed944", "city": "广州", "project": "辣鸡", "max_amount": 200, "reason": "辣鸡", "max_rate": 4.9, "loan_ddl": 12, "mortgage_value": 0, "guarentee_amount": 0, "supportSales": false, "supportOther": false, "risk_factor": null, "total_risk_factor": null, "from": { "_id": "59a55a94ff71d31c94d5349c", "comName": "华为科技", "comCapital": 300, "comTime": "1997.09.10", "comPhone": "0992-2121898", "comRegistAddresss": "广东省揭阳市", "comWorkAddresss": "广东省揭阳市", "comField": "采矿业", "comProduct": "煤矿", "comIntro": "美好", "comCreditScore": 85, "comHistoryScore": 86, "comAttributeScore": 77, "comIntegrityScore": 89 }, "__v": 0, "date": "2017-08-29T13:20:29.903Z" }
-
GET
/api/loan/detail/lend?id=LENDID
-
{ "_id": "59a5694442e9f105809ed942", "max_amount": 200, "loan_ddl": 12, "from": { "_id": "59a55a94ff71d31c94d5349c", "comName": "华为科技", "comCapital": 300, "comTime": "1997.09.10", "comPhone": "0992-2121898", "comRegistAddresss": "广东省揭阳市", "comWorkAddresss": "广东省揭阳市", "comField": "采矿业", "comProduct": "煤矿", "comIntro": "美好", "comCreditScore": 85, "comHistoryScore": 86, "comAttributeScore": 77, "comIntegrityScore": 89 }, "__v": 0, "date": "2017-08-29T13:16:52.991Z" }
-
-
GET
/api/loan/recommend?id=BORROWID
-
[ { "_id": "59a412aa5427b5622c4fdf11", "max_amount": 344, "loan_ddl": 12, "from": "59a3bc193cde380b1cef10a5", "__v": 0, "date": "2017-08-28T12:55:06.996Z" }, { "_id": "59a412ab5427b5622c4fdf12", "max_amount": 344, "loan_ddl": 12, "from": "59a3bc193cde380b1cef10a5", "__v": 0, "date": "2017-08-28T12:55:07.270Z" }, { "_id": "59a412ab5427b5622c4fdf13", "max_amount": 344, "loan_ddl": 12, "from": "59a3bc193cde380b1cef10a5", "__v": 0, "date": "2017-08-28T12:55:07.598Z" } ]
-
GET
/api/loan/messages
-
[ { "_id": "59a41b35cc066138d0ac9b1e", "type": "BorrowContract-Accepted", "from": "59a3bc193cde380b1cef10a5", "info": { "transactionId": "59a415ee1437f23db0f4d8e8" }, "__v": 0, "date": "2017-08-28T13:31:33.510Z", "read": false }, { "_id": "59a41ae5e005ea1d70a4df6a", "type": "BorrowContract-Accepted", "from": "599fe35e6e76741bf0b321cd", "info": { "transactionId": "59a415ee1437f23db0f4d8e8" }, "__v": 0, "date": "2017-08-28T13:30:13.487Z", "read": false }, { "_id": "59a41a1e4527a415b4b42389", "type": "BorrowContract-Received", "from": "59a3bc193cde380b1cef10a5", "info": { "transactionId": "59a415ee1437f23db0f4d8e8" }, "__v": 0, "date": "2017-08-28T13:26:54.448Z", "read": false }, { "_id": "59a418e31a5c072fc0eb677a", "type": "BorrowRequest-Accepted", "from": "59a3bc193cde380b1cef10a5", "info": { "transactionId": "59a415ee1437f23db0f4d8e8" }, "__v": 0, "date": "2017-08-28T13:21:39.453Z", "read": false } ]
-
note:
info.transactionId
is quite important
-
POST
/api/loan/request
-
{ "borrowId": "", "lendId": "" }
-
note:
borrowId
andlendId
are provided in get recommend api and get my borrow api- once this API is called:
- a transaction is created
- the lender get a
BorrowRequest-Received
message
-
POST
/api/loan/accept-request
-
{ "messageId": "" }
-
note:
messageId
is provided in message of typeBorrowRequest-Received
(field_id
)- once this API is called, the borrower get a
BorrowRequest-Accepted
message
-
POST
/api/loan/transaction
-
{ "messageId": "" }
-
note:
messageId
is provided in message of typeBorrowRequest-Accpted
(field_id
)- once this API is called, the lender get a
BorrowContract-Received
message
-
POST
/api/loan/accept-transaction
-
{ "messageId": "" }
-
note:
messageId
is provided in message of typeBorrowContract-Received
(field_id
)- once this API is called, both lender & borrower get a
Borrow-Completed
message
-
GET
/api/timeline?page=PAGE&size=SIZE
-
[ { "_id": "59a531fa68aa9638dcce650a", "from": "59a3bc193cde380b1cef10a5", "type": "Borrow", "info": { "borrowId": "59a531fa68aa9638dcce6509" }, "__v": 0, "date": "2017-08-29T09:20:58.257Z" }, { "_id": "59a531d816c1c918fcf80f99", "from": "59a3bc193cde380b1cef10a5", "type": "Borrow", "info": { "borrowId": "59a531d816c1c918fcf80f98" }, "__v": 0, "date": "2017-08-29T09:20:24.921Z" } ]
- GET
/api/timeline/me?page=PAGE&size=SIZE
- same as get timeline
-
POST
/api/gurantee/lend
-
{ "amount_gurantee": 1, "loan_ddl": 12, "min_rate": 0.3 }
-
POST
/api/gurantee/borrow
-
{ "city": "", "project": "", "amount_gurantee": 1, "reason": "", "max_rate": 3, "loan_ddl": 12, "other_detail": "" }
-
GET
/api/gurantee/borrow
-
[ { "_id": "59b017762bc84c4c2cce798a", "city": "广州", "project": "smart", "cost": 12, "amount_gurantee": 30, "rate_gurantee": 0.7, "loan_ddl": 5, "reason": "no reason", "other_detail": "???", "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:42:46.279Z" }, { "_id": "59b01d7d971a3f2e60e882b4", "city": "广州", "project": "smart", "cost": 12, "amount_gurantee": 30, "rate_gurantee": 0.7, "loan_ddl": 5, "reason": "no reason", "other_detail": "???", "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T16:08:29.497Z" } ]
-
GET
/api/gurantee/lend
-
[ { "_id": "59b01551fd1b5147d87d4f12", "amount_guarantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:33:37.977Z" }, { "_id": "59b015b740fb94502c910fc1", "amount_guarantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:35:19.656Z" }, { "_id": "59b018e33c407d502ca7a8b9", "amount_gurantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:48:51.301Z" }, { "_id": "59b018e43c407d502ca7a8bb", "amount_gurantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:48:52.275Z" } ]
-
GET
/api/gurantee/detail/seek?id=SEEKID
-
{ "_id": "59b017762bc84c4c2cce798a", "city": "广州", "project": "smart", "cost": 12, "amount_gurantee": 30, "rate_gurantee": 0.7, "loan_ddl": 5, "reason": "no reason", "other_detail": "???", "from": { "_id": "59ae8735dd5a292fa821f2cd", "comName": "华为短34", "comCapital": 23232, "comTime": "1", "comPhone": "1", "comRegistAddresss": "1", "comWorkAddresss": "1", "comField": "1", "comProduct": "1", "comIntro": "1", "comCreditScore": 89, "comHistoryScore": 70, "comAttributeScore": 88, "comIntegrityScore": 109 }, "__v": 0, "date": "2017-09-06T15:42:46.279Z" }
-
GET
/api/gurantee/detail/offer?id=OFFERID
-
{ "_id": "59b018e43c407d502ca7a8bb", "amount_gurantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": { "_id": "59ae8735dd5a292fa821f2cd", "comName": "华为短34", "comCapital": 23232, "comTime": "1", "comPhone": "1", "comRegistAddresss": "1", "comWorkAddresss": "1", "comField": "1", "comProduct": "1", "comIntro": "1", "comCreditScore": 89, "comHistoryScore": 70, "comAttributeScore": 88, "comIntegrityScore": 109 }, "__v": 0, "date": "2017-09-06T15:48:52.275Z" }
-
-
GET
/api/gurantee/recommend/single?id=SEEKID
-
[ { "_id": "59b018e33c407d502ca7a8b9", "amount_gurantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:48:51.301Z" }, { "_id": "59b018e43c407d502ca7a8bb", "amount_gurantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:48:52.275Z" } ]
-
GET
/api/gurantee/recommend/multi?id=SEEKID
-
[ { "_id": "59b018e33c407d502ca7a8b9", "amount_gurantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:48:51.301Z" }, { "_id": "59b018e43c407d502ca7a8bb", "amount_gurantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:48:52.275Z" }, { "_id": "59b01551fd1b5147d87d4f12", "amount_guarantee": 300, "loan_ddl": 12, "min_rate": 0.3, "from": "59ae8735dd5a292fa821f2cd", "__v": 0, "date": "2017-09-06T15:33:37.977Z" } ]
-
GET
/api/gurantee/messages
-
[ { "_id": "59b01d7d971a3f2e60e882b6", "type": "Publish-GuranteeSeek", "info": { "seekId": "59b01d7d971a3f2e60e882b4" }, "__v": 0, "date": "2017-09-06T16:08:29.511Z", "read": false }, { "_id": "59b01c031565a86490e64acb", "type": "Gurantee-Completed", "info": { "transaction": { "_id": "59b01b1d12ba8e44d802d7c3", "from": "59ae8735dd5a292fa821f2cd", "offer": "59b018e43c407d502ca7a8bb", "seek": "59b017762bc84c4c2cce798a", "__v": 0, "status": "Progressing", "date": "2017-09-06T15:58:21.058Z" } }, "__v": 0, "date": "2017-09-06T16:02:11.763Z", "read": false }, { "_id": "59b01c031565a86490e64aca", "type": "GuranteeContract-Accepted", "from": "59ae8735dd5a292fa821f2cd", "info": { "transaction": { "_id": "59b01b1d12ba8e44d802d7c3", "from": "59ae8735dd5a292fa821f2cd", "offer": "59b018e43c407d502ca7a8bb", "seek": "59b017762bc84c4c2cce798a", "__v": 0, "status": "Progressing", "date": "2017-09-06T15:58:21.058Z" } }, "__v": 0, "date": "2017-09-06T16:02:11.763Z", "read": false }, { "_id": "59b01c031565a86490e64acb", "type": "Gurantee-Completed", "info": { "transaction": { "_id": "59b01b1d12ba8e44d802d7c3", "from": "59ae8735dd5a292fa821f2cd", "offer": "59b018e43c407d502ca7a8bb", "seek": "59b017762bc84c4c2cce798a", "__v": 0, "status": "Progressing", "date": "2017-09-06T15:58:21.058Z" } }, "__v": 0, "date": "2017-09-06T16:02:11.763Z", "read": false }, { "_id": "59b01bd51565a86490e64ac8", "type": "GuranteeContract-Received&Accepted", "from": "59ae8735dd5a292fa821f2cd", "info": { "transaction": { "_id": "59b01b1d12ba8e44d802d7c3", "from": "59ae8735dd5a292fa821f2cd", "offer": "59b018e43c407d502ca7a8bb", "seek": "59b017762bc84c4c2cce798a", "__v": 0, "status": "Progressing", "date": "2017-09-06T15:58:21.058Z" } }, "__v": 0, "date": "2017-09-06T16:01:25.569Z", "read": false }, { "_id": "59b01b901565a86490e64ac7", "type": "GuranteeRequest-Accepted", "from": "59ae8735dd5a292fa821f2cd", "info": { "transaction": { "_id": "59b01b1d12ba8e44d802d7c3", "from": "59ae8735dd5a292fa821f2cd", "offer": "59b018e43c407d502ca7a8bb", "seek": "59b017762bc84c4c2cce798a", "__v": 0, "status": "Progressing", "date": "2017-09-06T15:58:21.058Z" } }, "__v": 0, "date": "2017-09-06T16:00:16.398Z", "read": false }, { "_id": "59b01b1d12ba8e44d802d7c4", "type": "GuranteeRequest-Received&Accepted", "from": "59ae8735dd5a292fa821f2cd", "info": { "transaction": { "_id": "59b01b1d12ba8e44d802d7c3", "from": "59ae8735dd5a292fa821f2cd", "offer": "59b018e43c407d502ca7a8bb", "seek": "59b017762bc84c4c2cce798a", "__v": 0, "status": "Progressing", "date": "2017-09-06T15:58:21.058Z" } }, "__v": 0, "date": "2017-09-06T15:58:21.061Z", "read": false }, { "_id": "59b01b1d12ba8e44d802d7c5", "type": "GuranteeRequest-Sent", "info": { "transaction": { "_id": "59b01b1d12ba8e44d802d7c3", "from": "59ae8735dd5a292fa821f2cd", "offer": "59b018e43c407d502ca7a8bb", "seek": "59b017762bc84c4c2cce798a", "__v": 0, "status": "Progressing", "date": "2017-09-06T15:58:21.058Z" } }, "__v": 0, "date": "2017-09-06T15:58:21.061Z", "read": false }, { "_id": "59b018e43c407d502ca7a8bc", "type": "Publish-GuranteeOffer", "info": { "offerId": "59b018e43c407d502ca7a8bb" }, "__v": 0, "date": "2017-09-06T15:48:52.275Z", "read": false }, { "_id": "59b018e33c407d502ca7a8ba", "type": "Publish-GuranteeOffer", "info": { "offerId": "59b018e33c407d502ca7a8b9" }, "__v": 0, "date": "2017-09-06T15:48:51.302Z", "read": false }, { "_id": "59b017762bc84c4c2cce798c", "type": "Publish-GuranteeSeek", "info": { "seekId": "59b017762bc84c4c2cce798a" }, "__v": 0, "date": "2017-09-06T15:42:46.284Z", "read": false }, { "_id": "59b015b740fb94502c910fc2", "type": "Publish-GuranteeOffer", "info": { "offerId": "59b015b740fb94502c910fc1" }, "__v": 0, "date": "2017-09-06T15:35:19.659Z", "read": false } ]
-
note:
info.transactionId
is quite important
-
POST
/api/gurantee/request
-
{ "seekId": "", "offerId": "" }
-
note:
seekId
andofferId
are provided in get recommend api and get my seek api- once this API is called:
- a transaction is created
- the offerer get a
GuranteeRequest-Received
message
-
POST
/api/gurantee/accept-request
-
{ "messageId": "" }
-
note:
messageId
is provided in message of typeGuranteeRequest-Received
(field_id
)- once this API is called, the seeker get a
GuranteeRequest-Accepted
message
-
POST
/api/gurantee/transaction
-
{ "messageId": "" }
-
note:
messageId
is provided in message of typeGuranteeRequest-Accpted
(field_id
)- once this API is called, the offerer get a
GuranteeContract-Received
message
-
POST
/api/gurantee/accept-transaction
-
{ "messageId": "" }
-
note:
messageId
is provided in message of typeGuranteeContract-Received
(field_id
)- once this API is called, both lender & seeker get a
Gurantee-Completed
message
-
POST
/api/bondtrade/sell
-
{ "company_lend": "", "company_borrow": "", "amount": "", "loan_owner": "", "loan_amount": "", "loan_ddl": "", "loan_source": "", "situation_borrower": "", "loan_price: "" }
-
note:
bondId
is returned- a timeline-item with type
BondSell
is created
-
GET
/api/bondtrade/all?page=PAGE&size=SIZE
-
[ { "_id": "59b383ee2e75253284554711", "company_lend": "华为科技", "company_borrow": "淘宝商城", "amount": "20", "loan_owner": "辣鸡华为", "loan_amount": "20", "loan_ddl": "12", "loan_source": "1", "situation_borrower": "1", "loan_price": "12", "from": "59b1667ffc29b9026c0b406e", "__v": 0, "date": "2017-09-09T06:02:22.097Z" }, { "_id": "59b38fe82e75253284554713", "company_lend": "华为科技", "company_borrow": "淘宝商城", "amount": "18", "loan_owner": "辣鸡项目", "loan_amount": "18", "loan_ddl": "12", "loan_source": "1", "situation_borrower": "1", "loan_price": "10", "from": "59b1667ffc29b9026c0b406e", "__v": 0, "date": "2017-09-09T06:53:28.383Z" } ]
-
GET
/api/bondtrade/detail/BONDTRADEID
-
{ "_id": "59b383ee2e75253284554711", "company_lend": "华为科技", "company_borrow": "淘宝商城", "amount": "20", "loan_owner": "辣鸡华为", "loan_amount": "20", "loan_ddl": "12", "loan_source": "1", "situation_borrower": "1", "loan_price": "12", "from": "59b1667ffc29b9026c0b406e", "__v": 0, "date": "2017-09-09T06:02:22.097Z" }