Earlier this year our team has released public API (documentation is available here). In this update, we would like to describe API integration cases and explain the benefits.
This article is mainly dedicated to developers and potential partners, but it also can be useful to active community members, who are curious about our platform features.
What is API?
As Wikipedia says — “API is an interface or communication protocol between a client and a server”. In simple words, it can be described as a protocol that returns data, likely in JSON or XML format.
API facilitates the integration between two services by abstracting the underlying implementation and only exposing objects or actions the developer needs.
Example. While a graphical interface of the Dashboard provides a user with input fields and buttons to perform withdraw operation, an API gives the developer a function that withdraws coins to a specified address without requiring that the developer know the platform address routing and operations occurring behind the scenes.
Public API integration with StackOfStake
Here we will try to describe two cases of public API integration with our platform. And there are more cases existed :)
This is the most basic case that can be used. If you are developing an application for personal use or looking to engage with StackOfStake in terms of DeFi — this is a good option.
To get started, the user needs to register at StackOfStake and generate API keys at the settings.
There are multiple key types available. Each type can be useful in a certain scenario.
- ReadOnly for a portfolio tracking app. The place where the user is collecting balances from all platforms and services he is using can view the entire portfolio in one place.
- Deposit for savings app. Where some part of the main user’s balance is diversifying into multiple ways of passive income (including receiving stakes at StackOfStake).
- Withdrawal for DeFi product. There are a lot of cool things can be created: portfolio rebalancing, portfolio hedging, creation of various derivatives based on stakes, etc.
In this case, your service is generating and handing the only API key.
It is more complicated (see later why), but you can charge from users by providing the staking option to them!
Using this option, you also need to have the own user balance management and dividends distribution (dividends that are received from StackOfStake) algorithms. StackOfStake works only as a dividends provider in this case.
This case can be useful for a wide range of cryptocurrency services and platforms: small exchanges, mining pools, private investment companies, etc. We have our powerful infrastructure available for use, so you don’t need to create yours!
This is the most advanced option of integration with StackOfStake infrastructure and the best option to earn with us. We can fully manage your users’ deposits, balances, dividends, withdraws.
If you are looking to extend the variety of services and already managing big amount of digital assets that can be staked — contact us for more details!
If you are interested in integration with StackOfStake or have cool ideas for cooperation — send DM to Lova or Qlee at our Discord server, or drop the line to email@example.com.