Links

Previous versions (not supported)

Out of date, not supported

v0.7

New Features:

  • Attribute entities and their endpoints are introduced:
    • Country
    • Currency
    • Unit
    • Language
    • Asset Class
    • Asset Detail Class
    • Search Property
  • Asset of type 'currency' (cash and cash equivalent) can be created with currencyCode parameter instead of unitOfMeasureCode. Check the rules of CurrencyCode definition
  • Invoice state changes events are delivered. More details here
  • Method to retrieve ETH balances of addresses
  • Method to retrieve external wallets saved in WLM

Changes:

  • All responses with asset data contain uniqueAssetId in hex format, now with leading 0x
  • Asset entity structure is changed, to reflect referenced attribute entities
  • CreateUnits, DestroyUnits, TransferUnits methods have "type" parameter as part of the response. Starting from v0.7 value of this parameter is case-sensitive and must start with capital letter, i.e. "type": "Sparks"
  • Routing keys of all events produced by TEOS API have prefix tenant-id which is taken from claims of authentication token
Breaking changes:
  • UniqueAssetId values are now prefixed with "0x"
  • Asset properties are renamed
    • Language -> LanguageCode
    • Jurisdiction -> JurisdictionCode
    • UnitOfMeasure -> UnitOfMeasureCode
    • Currency -> CurrencyCode
    • AssetClass -> AssetClassCode
  • CreateUnits, DestroyUnits, TransferUnits methods have "type" parameter as part of the response. Starting from v0.7 value of this parameter is case-sensitive and must start with capital letter, i.e. "type": "Sparks"

Fixed Bugs:

  • Teosapi wallets/InitWalletRegistration throws 500 when called with api key

v0.6

New Features:

  • New concept "Invoices" is introduced. Concept description can be found here. Functionality introduced:
    • Create invoice
    • Retrieve invoice details
    • Cancel invoice
    • Pay invoice

Changes:

  • Link assets updated: check whether asset exists is removed

Fixed Bugs:

  • SparkOperation method getting 500 error for specific addresses
  • Transfer units - Missleading error message
  • Incorrect message for Transfer/Destroy units in the Transaction method
  • GET Methods return incorrect Time or no Timezone

v0.5

New Features:

  • User data deletion from WLM and TEOS API
  • New endpoint for connecting to RabbitMQ with TLS encryption
Existing RabbitMQ connection endpoints without TLS encryption will be removed when TEOS API v0.4 support is over

Changes:

  • OData standard is enforced more in the area of function parameters and custom types
    • UniqueAssetId, Address and AssetId type constants should be obligatory in single quotes now, e.g. '0x094b3c71f99d3eccc5c3c0001'
    • Resource path should be composed, using entity key in parenthesis, e.g. /assets('0x094b3c71f99d3eccc5c3c0001')
Deprecated: The asset referencing using "resource/key" style

v0.4

New Features:

  • Retrieve transactions
    • GET /transactions - transaction retrieval request with filter possibility
  • Retrieve Spark Operations
    • POST /sparkoperations/search - initiates a search for spark operations

v0.3

New Features:

  • Balances
    • GET /balances(Address='xxx',UniqueAssetId='yyy') - return a balance for specific address-asset combination without restriction per tenant/user. xxx - valid address hex representation (case-insensitive, with or without 0x prefix), yyy - valid unique asset id hex representation (case-insensitive)
  • Warps
    • POST /warps/search - initiates a warp-search
    • POST /warps/execute - executes a warp
    • POST /assets('{key}')/linkasset - links an asset
  • TEOS Events through RabbitMQ
  • Link Assets

v0.2

New Features:

  • Assets
    • POST /assets('{key}')/createunits - creates asset units (sparks)
    • POST /assets('{key}')/transferunits - transfers sparks between two addresses
    • POST /assets('{key}')/destroyunits - destroys sparks for an asset
  • Balances
    • GET /balances - get balances of all own wallets

Changes:

  • Parameter validation and error handling are significantly improved
  • Unbound action "DocumentDbRecord" now is a bound function on assets entity set
  • Unbound action "Search" now is a bound function on assets entity set and is a GET function that accepts search parameters
  • Asset structure is changed
    • Mandatory 'Data' and optional documentation fields are removed
    • new mandatory and optional fields are added
    • Added a possibility to define custom item definitions and their values

v0.1

This is CoreLedger's first new API, intended to consolidate all existing functionalities and microservices and provide standartized consistent way to use them. Provides MVP functions with limited parametrization possibilities.

Features

  • Wallets
    • GET /wallets - returns all signable wallets of the current user or signable wallets of all users, if the token is the api key
    • GET /wallets/{key} - returns specific wallet information
    • DELETE /wallets/{key} - deletes specific wallet
    • POST /InitWalletRegistration - initiates signable address creation and linking with tx server provider
  • Assets
    • GET /assets - returns all assets of the current user, where one of the current user signable addresses is issuer of an asset. Or it returns assets of all users, if the token is the api key, by matching user signable addresses to asset issuer.
    • GET /assets/{key} - returns specific asset information
    • POST /assets (Body: Asset) - creates an asset creation transaction. Asset object in the body describes essential fields, like Name or Issuer. Multiple other document fields are hardcoded in this version of API
    • GET /DocumentDbRecord/{assetId} - returns asset details in json format
    • POST /search (Body: AssetSearchInput) - searches for assets using issuer address or asset name and returns list of found assets
  • Transactions
    • GET /transactions/{key} - returns specific transaction information
  • System
    • GET /version - returns current api version