📘
TEOS User Guides
Contact CoreLedgerPrivacy Policy
TEOS API
TEOS API
  • 👋Welcome to TEOS API
  • Get started
  • TEOS API overview
    • Terms and concepts
      • Asset
      • Spark
      • Wallet
      • Supply
      • Warp
      • Invoice
      • Transaction
    • Architecture note
      • Tenant setup options
    • Authentication
    • Versioning
  • Using TEOS API
    • Postman examples
    • Rate limits
    • Dealing with blockchain transactions
      • How to get Ether for signing transactions
      • Transaction creation and submission
        • First transaction creation and submission for a new address on the private blockchain
    • Handling errors
      • 1xxxx codes
      • 2xxxx codes
      • 3xxxx codes
    • TEOS Events
    • Warp search
  • TEOS API references
    • TEOS API Swagger (OpenAPI)
  • Using additional APIs of TEOS Platform
    • User authentication flow with TEOS Authentication service and TMS
    • Device authorization flow with TxServer and TEOS Authentication service
    • Adding wallet to the TEOS Platform flow with TxServer and TEOS API
    • Using TxServer API
      • TxServer API (OpenAPI)
      • Key Pair Generation. Transaction Signing
      • Device Restoration
    • Using TEOS Authentication service
      • TEOS Authentication Service API
    • Using TMS API
      • TMS API Swagger (OpenAPI)
      • Handling errors
      • Changelog
    • Using Discovery Service
  • FAQ
  • Changelog
    • v0.9
    • Non-versioned changes
    • Previous versions (not supported)
  • Troubleshooting
Powered by GitBook
On this page
  • Main things to know when using TMS API
  • HTTP-based
  • Rate limits
  • Versions

Was this helpful?

Edit on GitHub
  1. Using additional APIs of TEOS Platform

Using TMS API

PreviousUsing TEOS Authentication serviceNextHandling errors

Last updated 1 year ago

Was this helpful?

Additional APIs are required to be used along with TEOS API in case TEOS API Consumer doesn't have its own authentication service and needs TEOS Authentication service.

Tenant Management Service /TMS/ is used to get user data and sign up new user in TEOS Platform.

Check .

Main things to know when using TMS API

HTTP-based

All data transfers conform to HTTP/1.1, and all endpoints require HTTPS. Because the TMS API is HTTP-based, it works with any language that has an HTTP library, such as cURL and urllib. This means you can use the TMS API directly in your browser. For example, requesting this URL in your browser...

.. is equivalent to performing this cURL request:

curl -X 'GET' \
  'https://tms.coreledger.net/odata/v1' \
  -H 'accept: application/json'

Rate limits

A rate limit is the number of API calls a consumer can make within a given time period. If this limit is exceeded or if CPU or total time limits are exceeded, the consumer may be throttled. API requests made by a throttled consumer will fail.

Real-time rate limit usage statistics are described in headers that are included with most API responses once enough calls have been made to an endpoint. Once a rate limit is reached, any subsequent requests made by your app will fail and the API will return an error code until enough time has passed for the call count to drop below the limit.

Platform Rate Limits

Calls within twenty-four hours = 10000

To prevent the spikes in a short time, the default limit of 100 calls per minute is applied:

Calls within a minute = 100

Headers

If a consumer exceeds the TMS API rate limits, the response will have HTTP Status Code 429 and contain a header X-Rate-Limit-Resetwith value, represeting UTC date time (ISO 8601) when the limits resets.

client can parse the X-Rate-Limit-Reset like this:

DateTime resetDate = DateTime.ParseExact(resetHeader, "o", 
    DateTimeFormatInfo.InvariantInfo);

Best Practices

  • When the limit has been reached, stop making API calls. Continuing to make calls will continue to increase your call count, which will increase the time before calls will be successful again.

  • Spread out queries evenly to avoid traffic spikes.

Versions

The TMS API has multiple versions. You can read more about versioning in Versioning.

Build your query with the endpoint containing necessary version. For example, here's a call to version 1:

curl -X 'GET' \
  'https://tms.coreledger.net/v1/users' \
  -H 'accept: application/json'

We don't expect a lot of changes coming, but you can always find the latest versions in the Changelog.

Currently there are two available versions:

  • v1 which we strongly recommend to use

  • v0.1 which is deprecated

All API requests are subject to rate limits. TMS API requests are subject to .

TMS API requests made with an or are counted against that tenant’s rate limit. A tenant’s call count is the number of calls it can make during a rolling twenty-four-hour window and is defined as follows:

Platform Rate Limits
TMS API swagger
Read more
API key
user access token
https://tms.coreledger.net/odata/v1tms.coreledger.net