publishSmartVoucher

You are able to publish Smart Voucher via this API.

GraphQL API

• Query String
  
  mutation publishVoucher($input: PublishVoucherInput!) { publishVoucher(input: $input) { transaction hash submitToken } }

  1 2 3 4 5 6 7 8 9

  mutation publishVoucher($input: PublishVoucherInput!) {   publishVoucher(input: $input) {     transaction     hash     submitToken   } }

• Query Variables
  
  { "input":{ "name":"Glass", "symbol":"GALIFE_GLASS", "consumable":true, "totalSupply":"5000", "price": { "numerator":"2000000000000000000000", "denominator":"1" }, "expiry":"1577807999000", "description":"this is description", "proofOfContract":null } }

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  {   "input":{     "name":"Glass",     "symbol":"GALIFE_GLASS",     "consumable":true,     "totalSupply":"5000",     "price": {       "numerator":"2000000000000000000000",       "denominator":"1"     },     "expiry":"1577807999000",     "description":"this is description",     "proofOfContract":null   } }

• HTTP Headers
  
  { "accept": "application/json", "content-type": "application/json", "authorization": "bearer [JWT Web-to-Server access token]" }

  1 2 3 4 5 6 7

  {   "accept": "application/json",   "content-type": "application/json",   "authorization": "bearer [JWT Web-to-Server access token]" }

HTTP Request and Response

Request

• URL
  • For development: https://test.fstk.io/api
  • For production: https://engine.fstk.io/api
• Method: POST
• Headers
  • accept: application/json
  • content-type: application/json
  • authorization: Bearer [JWT Web-to-Server access token]
    • (for example)
      
      Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImZzdGstZW5naW5lIn0.eyJ1aWQiOiLDr1xiw73Ch8KDSFx1MDAxMcOowo5awrvCqsOAXHUwMDAywrwmIiwiaWF0IjoxNTM4NzA5MDM2LCJleHAiOjE1Mzg3OTU0MzYsImF1ZCI6InVybjpmc3RrOmVuZ2luZSIsImlzcyI6InVybjpmc3RrOmVuZ2luZSIsInN1YiI6InVybjpmc3RrOmVuZ2luZTphY2Nlc3NfdG9rZW4ifQ.msJZ61FHIkKtjUpDs4sx1Kk1rb9vdhus3ntUDj6rHNmsygiHTgOEMQFJMtVqtWqkNgrtRgGpngq8Rf47xTT53g

      1 2 3

      Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImZzdGstZW5naW5lIn0.eyJ1aWQiOiLDr1xiw73Ch8KDSFx1MDAxMcOowo5awrvCqsOAXHUwMDAywrwmIiwiaWF0IjoxNTM4NzA5MDM2LCJleHAiOjE1Mzg3OTU0MzYsImF1ZCI6InVybjpmc3RrOmVuZ2luZSIsImlzcyI6InVybjpmc3RrOmVuZ2luZSIsInN1YiI6InVybjpmc3RrOmVuZ2luZTphY2Nlc3NfdG9rZW4ifQ.msJZ61FHIkKtjUpDs4sx1Kk1rb9vdhus3ntUDj6rHNmsygiHTgOEMQFJMtVqtWqkNgrtRgGpngq8Rf47xTT53g

• Body
  
  ------WebKitFormBoundaryZ8JmbMyPiS7ZuVmj Content-Disposition: form-data; name="operations" { "query":"mutation publishVoucher($input: PublishVoucherInput!) { publishVoucher(input: $input) { transaction hash submitToken } }", "variables": { "input":{ "name":"Glass", "symbol":"GALIFE_GLASS", "consumable":true, "totalSupply":"5000", "price": { "numerator":"2000000000000000000000", "denominator":"1" }, "expiry":"1577807999000", "description":"this is description", "proofOfContract":null } } } ------WebKitFormBoundaryZ8JmbMyPiS7ZuVmj Content-Disposition: form-data; name="map" {"proofOfContract":["variables.input.proofOfContract"]} ------WebKitFormBoundaryZ8JmbMyPiS7ZuVmj Content-Disposition: form-data; name="proofOfContract"; filename="test.pdf" Content-Type: application/pdf proofOfContract file content ------WebKitFormBoundaryZ8JmbMyPiS7ZuVmj--

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

  ------WebKitFormBoundaryZ8JmbMyPiS7ZuVmj Content-Disposition: form-data; name="operations"   {   "query":"mutation publishVoucher($input: PublishVoucherInput!) { publishVoucher(input: $input) { transaction hash submitToken } }",   "variables": {     "input":{       "name":"Glass",       "symbol":"GALIFE_GLASS",       "consumable":true,       "totalSupply":"5000",       "price": {         "numerator":"2000000000000000000000",         "denominator":"1"       },       "expiry":"1577807999000",       "description":"this is description",       "proofOfContract":null     }   } } ------WebKitFormBoundaryZ8JmbMyPiS7ZuVmj Content-Disposition: form-data; name="map"   {"proofOfContract":["variables.input.proofOfContract"]} ------WebKitFormBoundaryZ8JmbMyPiS7ZuVmj Content-Disposition: form-data; name="proofOfContract"; filename="test.pdf" Content-Type: application/pdf   proofOfContract file content   ------WebKitFormBoundaryZ8JmbMyPiS7ZuVmj--

  
  The value of query in the body is a String. Please refer to GraphQL multipart request specification for files upload.

Response

Parameters

Request

• name <String!>
  • Smart Voucher name.
• symbol <String!>
  • Smart Voucher symbol.
• totalSupply <String!>
  • Total supply of the Smart Voucher. The format is Decimaled Number.
• price <Fraction!>
• Smart Voucher price.
• numerator <String!>
  • The numerator of this fraction.
• denominator <String!>
  • The denominator of this fraction.
• consumable <Boolean!>
  • The Smart Voucher is consumable or not.
• expiry <String!>
  • Expiry date of the Smart Voucher. The format is Unix Timestamp in millisecond resolution.
• description <Upload!>
  • Description of the Smart Voucher.
• por <enum PORMode>
  • ENABLE or DISABLE <enum>
  • Default is DISABLE.

Response

• publishVoucher <PublishVoucherPayload>
  • transaction <JSON>
    • UNSIGNED raw transaction format in Ethereum.
  • submitToken <String!>
    • The value for SubmitSignedTransaction API.
  • hash <String>
    • PORMode ENABLE: Hash of the abi encode.
    • PORMode DISABLE: Hash of the RLP encode.