Prototype API Usage Example

example.md

Register a user

curl -X POST https://api.projectwyvern.com/users/register -H 'Content-Type: application/json' -d '{"username":"test","ethereumAddress":""}'

{"success":true}

List an item

curl -X POST https://api.projectwyvern.com/items/create -H 'Content-Type: application/json' -d '{"username":"test","title":"Example Title","tags":["tagA"],"secretKey":"abc123","instantBuyPrice":10,"description":"Example Description","imageURL":"http://via.placeholder.com/200x200"}'

{"success":true}

Retrieve the list of items

curl -X GET https://api.projectwyvern.com/items

[{"id":1,"sellerName":"test","title":"Example Title","tags":["tagA"],"instantBuyPrice":10,"description":"Example Description","imageURL":"http://via.placeholder.com/200x200","sold":false}]

Buy an item (for the prototype we're omitting the actual purchase transaction)

curl -X POST https://api.projectwyvern.com/items/claim -H 'Content-Type: application/json' -d '{"itemId":1}'

{"success":true,"secretKey":"abc123","saleId":1}

Write a review

curl -X POST https://api.projectwyvern.com/reviews/create -H 'Content-Type: application/json' -d '{"rating":5,"note":"Example Note","saleId":1}'

{"success":true}

Retrieve the list of items again - item will now show as sold

curl -X GET https://api.projectwyvern.com/items

[{"id":1,"sellerName":"test","title":"Example Title","tags":["tagA"],"instantBuyPrice":10,"description":"Example Description","imageURL":"http://via.placeholder.com/200x200","sold":true}]

Retrieve the item details, including the review

curl -X GET https://api.projectwyvern.com/items/1/details

{"success":true,"item":{"sellerName":"test","title":"Example Title","tags":["tagA"],"instantBuyPrice":10,"description":"Example Description","imageURL":"http://via.placeholder.com/200x200","sold":true},"sale":{"salePrice":10},"review":{"note":"Example Note","rating":5}}