Catenis API

Catenis API Change Log

API ver. 0.12, 2022-08-09

  • New non-fungible asset related API methods:
    • Issue Non-Fungible Asset
    • Reissue Non-Fungible Asset
    • Retrieve Non-Fungible Asset Issuance Progress
    • Retrieve Non-Fungible Token
    • Retrieve Non-Fungible Token Retrieval Progress
    • Transfer Non-Fungible Token
    • Retrieve Non-Fungible Token Transfer Progress
  • Updated Reissue Asset, Transfer Asset, Export Asset, Migrate Asset and Asset Export Outcome API methods:
    • These methods accept only regular (fungible) assets. If an asset ID of a non-fungible asset is passed, they return the new error: [400] Not a regular (fungible) asset.
  • Updated Retrieve Asset Info API method:
    • Returns an additional property, namely isNonFungible, which indicates whether the asset is a non-fungible asset or not.
  • Updated Retrieve Asset Issuance History API method:
    • The issuance event entries returned for non-fungible assets are different from the ones returned for regular (fungible) assets, in that:
      • The amount property is replaced by a new nfTokenIds property, which lists the IDs of the non-fungible tokens that have been issued.
      • The holdingDevice property is replaced by a new holdingDevices property, which lists the Catenis virtual devices to which the issued non-fungible tokens have been assigned.
  • Updated version (ver. 0.5) of the Catenis notification service, which defines the following new notification events:
    • nf-asset-issuance-outcome - Non-fungible asset issuance has been finalized
    • nf-token-received - One or more non-fungible tokens have been received
    • nf-token-confirmed - One or more non-fungible tokens that were pending due to a non-fungible token transfer has been confirmed
    • nf-token-retrieval-outcome - Non-fungible token retrieval has been finalized
    • nf-token-transfer-outcome - Non-fungible token transfer has been finalized
  • Definition of the following new permission events:
    • receive-nf-token-of - Receive a non-fungible token issued by a device
    • receive-nf-token-from - Receive a non-fungible token from a device

API ver. 0.11, 2021-09-02

  • New asset export related API methods:
    • Export Asset
    • Migrate Asset
    • Asset Export Outcome
    • Asset Migration Outcome
    • List Exported Assets
    • List Asset Migrations
  • Updated List Asset Holders API method:
    • The returned list of asset holders may now include an entry that reports the total asset amount that is currently migrated to foreign blockchains
  • Updated version (ver. 0.4) of the Catenis notification service, which defines the following new notification events:
    • asset-export-outcome - Asset export has been finalized
    • asset-migration-outcome - Asset migration has been finalized

API ver. 0.10, 2020-06-26

  • New message related public API method:
    • Retrieve Message Origin

API ver. 0.9, 2020-01-21

  • Updated Log Message, Send Message, Read Message and Retrieve Message Container API methods:
    • added support for Catenis off-chain messages, which is on by default

API ver. 0.8, 2019-08-14

  • Updated List Messages and Retrieve Asset Issuance History API methods:
    • added new limit and skip parameters to query string
    • replaced countExceeded property with new hasMore property in returned data
  • New behavior for Retrieve Message Container API method:
    • target virtual device is now allowed to retrieve container info of received messages
  • Changes to Catenis notification service:
    • new URI format for notification endpoints, which are now only dependent on the API version

API ver. 0.7 (updated), 2019-05-30

  • New version (ver. 0.2) of the WebSocket message dispatcher, which includes the following new feature:
    • sends Notification Channel Open message in response to successfully received Authentication message

API ver. 0.7, 2019-03-16

  • Updated Log Message, Send Message and Read Message API methods:
    • added capability to pass/read message in chunks
    • added capability to process message asynchronously
  • New message related API method:
    • Retrieve Message Progress
  • Updated version (ver. 0.3) of the Catenis notification service, which defines the following new notification event:
    • final-msg-progress - Progress of asynchronous message processing has come to an end

API ver. 0.6, 2018-04-04

  • New smart asset related API methods:
    • Issue Asset
    • Reissue Asset
    • Transfer Asset
    • Retrieve Asset Info
    • Get Asset Balance
    • List Owned Assets
    • List Issued  Assets
    • Retrieve Asset Issuance History
    • List Asset Holders
  • Definition of the following new permission events:
    • receive-notify-asset-of - Receive notification of asset received for assets issued by a device
    • receive-notify-asset-from - Receive notification of asset received from a device
    • receive-notify-confirm-asset-of - Receive notification of confirmation of pending asset issued by a device
    • receive-notify-confirm-asset-from - Receive notification of confirmation of pending asset transferred by a device
    • receive-asset-of - Receive an amount of an asset issued by a device
    • receive-asset-from - Receive an amount of an asset from a device
  • Updated version (ver. 0.2) of the Catenis notification service, which defines the following new notification events:
    • asset-received - An amount of an asset has been received
    • asset-confirmed - An amount of an asset that was pending due to an asset transfer has been confirmed

API ver. 0.5, 2017-10-21

  • Updated Send Message API method:
    • added new readConfirmation property to the options input parameter
  • Updated List Messages API method:
    • added two new properties to the returned message entries: readConfirmationEnabled, and msgCount

API ver. 0.4, 2017-09-09

  • New permission related API methods:
    • List Permission Events
    • Retrieve Permission Rights
    • Set Permission Rights
    • Check Effective Permission Right
    • Retrieve Device Identification Info
  • New notification related API method:
    • List Notification Events
  • Definition of the following permission events:
    • receive-notify-new-msg - Receive notification of new message from a device
    • receive-notify-msg-read - Receive notification of message read by a device
    • send-read-msg-confirm - Send read message confirmation to a device
    • receive-msg - Receive message from a device
    • disclose-main-props - Disclose device's main properties (name, product unique ID) to a device
    • disclose-identity-info - Disclose device's basic identification information to a device
  • New Catenis notification service (ver. 0.1), which defines the following notification events:
    • new-msg-received - A new message has been received
    • sent-msg-read - Previously sent message has been read by intended receiver (target device)
  • New WebSocket notification message dispatcher (ver. 0.1)

API ver. 0.3, 2017-06-17

  • New message related API method:
    • List Messages
  • Updated Read Message API method:
    • added new action property to returned data

API ver. 0.2, 2017-04-08

  • New message related API method:
    • Retrieve Message Container
  • Updated Log Message and Send Message API methods:
    • removed txid property from returned data
    • added new messageId property to returned data

API ver. 0.1, 2017-02-24

  • Initial version including the following message related API methods:
    • Log Message
    • Send Message
    • Read Message
Copyright © 2018-2022, Blockchain of Things Inc. All rights reserved.