Here is the documentation for developers, which introduces the methods of this API.
\nAs a core platform has been used the Headless CMS Strapi.
\nAPI use protected HTTPS protocol for all endpoints.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6846240","collectionId":"03ab5ea1-3c15-40a5-a048-aa53194068f2","publishedId":"T1DjjK9k","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-17T18:51:17.000Z"},"item":[{"name":"Webshop requests","item":[{"name":"Get all webshops","id":"83c5ba35-a122-47e4-8a07-5d09e26a3077","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://pumacy-vm2.westeurope.cloudapp.azure.com/webshops","description":"Request type - GET
Returns an array of public information of available webshops.
\n","urlObject":{"path":["webshops"],"host":["https://pumacy-vm2.westeurope.cloudapp.azure.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"83c5ba35-a122-47e4-8a07-5d09e26a3077"},{"name":"Get webshop data","id":"7ea65c20-c99e-41c7-88fa-61826718c50b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://pumacy-vm2.westeurope.cloudapp.azure.com/webshops/0x89ce9ec30e2e761ec2ceaae8dd54f3174b00901d","description":"Request type - GET
Returns the publici data of the certain webshop:
\n:wallet: Ethereum address of the certain webshop (required)Request type - POST
For webshop registrations requester should provide:
\nwallet: Ethereum address which should be used for interaction in the future (required)website: The URL address of webshop (required)email: As a main contact (required)Request type - POST
For adding partner the webshop should provide:
\nwebshopAddr: Ethereum address of initiator webshop (required)partners: Array of ethereum addresses of selected partners (required)nonce: Nonce of initiator webshop, it can be found on on Get webshop data response (required)signature: Signed data done with initiator webshops' private key (required)Request type - POST
Similar to Add partner request, for removing partner the webshop should provide:
\nwebshopAddr: Ethereum address of initiator webshop (required)partners: Array of Ethereum address of selected partners (required)nonce: Nonce of initiator webshop, it can be found on on Get webshop data response (required)signature: Signed data done with initiator webshops' private key (required)The /webshop endpoint created for webshops creation, adding and removing partners. The public methods allowed participants to create new webshops, add and remove partner from existing webshop, get a list of webshops or information about certain webshop.
\n","event":[{"listen":"prerequest","script":{"id":"6d83a711-eb53-47b9-84b7-b2e583453fb8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0df760d5-d31c-4060-bc02-377f33a4480b","type":"text/javascript","exec":[""]}}],"_postman_id":"cf3e9c3f-2f3b-4030-9f53-adac61065e5f"},{"name":"Voucher requests","item":[{"name":"Redeem voucher","id":"73759286-f0a0-4596-b4fc-8a14ef90473e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"webshopAddr\": \"0xa7DD6E42EF9728DBE4793481b9b8E0703542a786\",\n \"amount\": \"50\",\n \"voucherId\": \"7\",\n \"nonce\": \"0\",\n \"signature\": \"0x203d22a7a3e5ca0d88bcf2e02f2670f2bdc561dbf3c4bcd417d92fc70d6eaac370ac5161c16585da852f09f58eb3b1cc8817cf35c7ea4af669a7e787568ad7cc1b\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pumacy-vm2.westeurope.cloudapp.azure.com/vouchers/redeem","description":"Request type - POST
For redeem voucher webshop should provide:
\nwebshopAddr: Ethereum address of initiator webshop (required)amount: Amount which should be redeemed (required)voucherId: Numerical voucher ID (required)nonce: Nonce of initiator webshop, it can be found on on Get webshop data response (required)signature: Signed data done with initiator webshops' private key (required)Request type - POST
For creat new voucher webshop should provide:
\nwebshopAddr: Ethereum address of initiator webshop (required)amount: Amount of vouchere (required)nonce: Nonce of initiator webshop, it can be found on on Get webshop data response (required)signature: Signed data done with initiator webshops' private key (required)Request type - GET
This method will be used for validate the voucher code (encoded string), and get the voucher ID (numerical). As a param requester should provide:
\nvoucherCode: Encoded string of voucher (required)webshopAddr: The address of webshop, where user want to redeem voucher (required)As a response it provides:
\nvoucherId and numerical valueVoucher endpoint created for interacting with vouchers, create, redeem, and validate it. Each voucher has its own decoded value, which does not save anywhere after creation on the database. Voucher code can be validated only by the user and redeemed after successful validation.
\n","event":[{"listen":"prerequest","script":{"id":"0e7c5bf6-b2d2-4c54-a42a-272bcd098af7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"77e29dc9-475a-4f8c-8bad-7cfa0f596992","type":"text/javascript","exec":[""]}}],"_postman_id":"c2d516ea-5402-4d31-a7e1-2e15090176b7"},{"name":"Demo data","item":[{"name":"Sign create voucher method","id":"1e756bf6-70e3-4ad7-a73c-8d6d0b0427f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": \"100\",\n \"nonce\": \"0\",\n \"privateKey\": \"0x520d755a6dfb95c5b69180b25fe94c72e0ab05b0a015d721fecf5d80c5fa5109\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pumacy-vm2.westeurope.cloudapp.azure.com/demos/createVoucher?amount=43200&nonce=0&privateKey=0x35cec5d404dbc493255e7fe7e4fa65836cf9f11d8999eabf319f1068cac6579e","description":"Request type - GET
This method returns signed data from provided values. As a param requester should provide:
\namount: Voucher amount (required)nonce: Nonce value (required)privateKey: Private key of webshop based Ethereum wallet (required)As a response it provides:
\nsignature: signed data (string)Request type - GET
This method returns signed data from provided values. As a param requester should provide:
\namount: Voucher amount (required)nonce: Nonce value (required)voucherId: Numerical Id of selected voucher, not the voucher code (required)privateKey: Private key of webshop based Ethereum wallet (required)As a response it provides:
\nsignature: signed data (string)Request type - GET
This method returns signed data from provided values. As a param requester should provide:
\npartner: Ethereum address of partner (required)nonce: Nonce value (required)privateKey: Private key of webshop based Ethereum wallet (required)As a response it provides:
\nsignature: signed data (string)Demo data is an experimental endpoint that should help to test until thee plugin development. It is done for data signing with provided values and nonce. It is extremely insecure for production because webshops should send their private keys via REST requests. After plugin development this endpoint should be removed.
\n","event":[{"listen":"prerequest","script":{"id":"f97dc5f0-53e8-4ed8-a737-eeca71739f17","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a7ee391b-08fc-415a-bcd5-0522333231f0","type":"text/javascript","exec":[""]}}],"_postman_id":"57fb386f-dca0-4104-8504-32efa25420a2"}],"event":[{"listen":"prerequest","script":{"id":"1766f084-9e99-4118-8d90-0eb6decdc72e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"57b3836a-da62-44e6-bd2a-dbe8ddf1abba","type":"text/javascript","exec":[""]}}],"variable":[{"key":"host","value":"https://pumacy-vm2.westeurope.cloudapp.azure.com"}]}