Skip to content

Instantly share code, notes, and snippets.

@Sagleft
Created October 31, 2018 14:58
Show Gist options
  • Save Sagleft/30f901e3872beaae7a9b7918d1368176 to your computer and use it in GitHub Desktop.
Save Sagleft/30f901e3872beaae7a9b7918d1368176 to your computer and use it in GitHub Desktop.
mfinotaur_api_docs.html
Регистрация
Чтобы использовать сервис авторизуйтесь с помощью Единого Логина Freeland.
После входа вы получите api_key и user_id для запросов к API.
О сервисе
MFinotaur API - сервис горячего MFCoin кошелька для ваших проектов.
Если вы не хотите арендовать VPS/VDS и устанавливать на сервер MFCoind, то можете воспользоваться нашим решением.
Возможности
Создание новых адресов.
Прием, отправка MFCoin.
Получение статистики сети MFCoin.
Для резидентов и граждан Фриленда у нас существуют бонусы.
API сервиса
Чтобы использовать API вам необходимо получить api_key и user_id. Все запросы - GET методом.
Навигация по разделам:
1. Авторизация
2. Запрос нового адреса
3. Запрос баланса
4. Отправка средств
Авторизация
Шаблон запроса:
https://mfinotaur.mfcoin.su/api?method=auth&api_key={api_key}&user_id={user_id}
Где:
{api_key} - ваш секретный ключ авторизации,
{user_id} - ваш ID пользователя.
Пример:
https://mfinotaur.mfcoin.su/api?method=auth&api_key=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08&user_id=0TGNB9C
Пример ответа:
{"status":"success","data":{"token":"KB7dDiLr9Y6NKbSjYqWtporHi8tgEEwd"},"error":""}
Где token - ключ необходимый для запросов после авторизации. Токен генерируется с каждой авторизацией.
Вы также можете не проводить авторизацию, а просто передавать api_key и user_id при каждом запросе. При этом передавать token не требуется.
Деавторизация
Вы можете перегенерировать токен доступа выполнив переавторизацию. Чтобы выйти выполните запрос:
https://mfinotaur.mfcoin.su/logout_api
Запрос нового адреса
Вы можете создать запрос на создание нового адреса. Существуют ограничения по типу вашей учетной записи:
Обычный пользователь: до 10 адресов.
до 100 адресов.
до 1000 адресов.
Если вы желаете отодвинуть эти лимиты, свяжитесь с Sagleft.
Шаблон запроса:
https://mfinotaur.mfcoin.su/api?method=getnewaddress&token={token}&alias={address_alias}
Где:
{address_alias} - любой идентификатор (максимум 64 символа, минимум 1 символ) адреса,уникальный для ваших адресов, по нему вы получите доступ к аккаунту адреса.
Под аккаунтом адреса понимается савокупность адресов под данным алиасом. Адрес, который вы получаете после выполнения данного запроса для данного аккаунта является основным. На него можно отправлять MFCoin для пополнения. После траты средств с аккаунта (с основного адреса аккаунта) могут быть созданы промежуточные адреса для сдачи с транзакции - эти дополнительные адреса будут привязаны к аккаунту.
Пример:
https://mfinotaur.mfcoin.su/api?method=getnewaddress&token=KB7dDiLr9Y6NKbSjYqWtporHi8tgEEwd&alias=myaddress
Пример ответа:
{"status":"success","data":{"address":"Mv1sSKsiZ53LUnvXiTzkrnnSiUESaNUXFU","alias":"myaddress"},"error":""}
Где:
address - MFCoin адрес сгенерированного адреса,
alias - алиас адреса.
Запрос баланса
Вы можете запросить баланс по конкретному своему адресу. Запросить его вы можете по алиасу или непосредственно по адресу кошелька. Шаблон запроса:
https://mfinotaur.mfcoin.su/api?method=getbalance&token={token}&alias={alias}
Где:
{alias} - алиас вашего адреса.
Или:
https://mfinotaur.mfcoin.su/api?method=getbalance&token={token}&address={address}
Где:
{address} - непосредственно MFCoin адрес.
Пример запроса:
https://mfinotaur.mfcoin.su/api?method=getbalance&token=13nZY9mhbT6B0VS6AMf0SZj2vjVYwXyE&address=MkHskBdxmXauGx1T14o6X6B3ruVuY3B8eb
Пример ответа:
{"status":"success","data":{"alias":"my_new_address","balance":0,"awaiting":5},"error":""}
Где:
{alias} - алиас вашего адреса, выдаст его при любом виде запроса баланса,
{balance} - баланс на аккаунте (основном адресе с данным алиас) с учетом 2 подтверждений сети,
{awaiting} - сколько монет сейчас находится в ожидании подтверждений сети, проще говоря разница между полным балансом и балансом с >=2 подтверждениями сети.
Отправка средств
Вы можете отправить средства на любой MFCoin адрес. Шаблон запроса:
https://mfinotaur.mfcoin.su/api?method=sendfrom&token={token}&alias={alias}&to_address={to_address}&amount={amount}&dir={dir}
Где:
{alias} - алиас адреса с которого необходимо отправить монеты,
{to_address} - MFCoin-адрес, на который монеты должны прийти,
{amount} - сумма для отправки.
Или:
https://mfinotaur.mfcoin.su/api?method=sendfrom&token={token}&address={address}&to_address={to_address}&amount={amount}&dir={dir}
Где:
{address} - ваш адрес, с которого необходимо отправить монеты,
{to_address} - MFCoin адрес, на который необходимо отправить монеты,
{amount} - сумма для отправки.
Памятка: транзакция также будет включать комиссию сети в размере 0.0001 mfc.
А также динамическая комиссия:
Обычный пользователь: 5%
0.5%
0.05%
Параметр {dir} - направление с которого будет списана комиссия, может быть в значении self и receiver. При этом:
Если {dir} в значении self, то комиссия будет списана с вас и итоговая сумма отправки не изменится, получатель получит точную сумму {amount}.
Если {dir} в значении receiver, то комиссия будет списана с получателя перевода и итоговая сумма отправки будет равна amount минус комиссия.
Обладатели VIP-статуса не платят динамическую комиссию. Чтобы узнать текущую цену на приобретение VIP-статуса, свяжитесь с Sagleft.
Пример запроса:
https://mfinotaur.mfcoin.su/api?method=sendfrom&token=rM8EBGcbGk4Hv4HFyG0BjRVCQXGd0BO7&alias=my_new_address&to_address=MjjZCaxdfU6FvrQ9dGFoauDzQeivt9cLsY&amount=2.5&dir=receiver
В данном примере:
Средства отправляются с алиаса my_new_address.
Платеж получит адрес MjjZCaxdfU6FvrQ9dGFoauDzQeivt9cLsY.
Отправляется 2.5 mfc, например, резидентом.
Тогда получателю достается (указано кто платит комиссию - получатель) 2.4874 mfc (вычет 0.5%).
Пример ответа:
{"status":"success","data":{"trid":"6f34903d4d58351d23258c23876fdb699308d7008dcc0de7dc827b992da31bd7"},"error":""}
Где:
trid - Transaction ID - идентификатор транзакции. Данные о транзакции можно посмотреть на block.mfcoin.net и на block2.mfcoin.net
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment