API asiakirjat

EnergyFather-palvelu auttaa ostamaan (vuokraamaan) energiaa ja kaistanleveyttä, joita tarvitaan transaktioiden lähettämiseen USDT:ssa ja muissa TRC20-krypto-tokeneissa; kaistanleveyttä tarvitaan myös kaikenlaisten transaktioiden lähettämiseen TRON-lohkoketjussa, kuten TRX:n lähettämiseen, palkintojen vaatimiseen ja Super Representatives:n äänestämiseen.

Energian ostomenettely

Ostaaksesi energiaa sinun täytyy rekisteröityä EnergyFather-palveluun, napata valtuutusmerkki sivulta "Ostaja > API merkit" ja täydentää Ostaja-tilin saldoa.

Toimeksiannon luomisen jälkeen (menetelmä ‘buy/energy’) energia voidaan toimittaa useiden sekuntien tai jopa minuuttien viiveellä, joten automatisoituja järjestelmiä kehitettäessä on suositeltavaa tarkistaa määräajoin toimeksiannon toteutuminen pyytämällä menetelmää ‘order/get/{guid}’.

Jos esimerkiksi aiot lähettää USDT ja haluat tehdä tapahtumista halvempia ostamalla energiaa, teet seuraavasti:

  • pyydä ‘buy/energy’-menetelmää tarvittavan energiamäärän arvioimiseksi ja sen ostamiseksi,
  • pyytää säännöllisesti ‘order/get/{guid}’-menetelmää, kunnes energia on delegoitu (yleensä se kestää muutaman sekunnin),
  • lähetä USDT (ostetulla energialla maksetaan transaktiomaksu).

Yleisiä huomautuksia

Tässä dokumentaatiossa sulkeisiin kääritty lauseke, kuten ‘{guid}’ tai ‘{id}’, tarkoittaa vastaavan muuttujan arvoa:

  • ‘{guid}’ on kohteen globaali yksilöllinen tunniste EnergyFather:ssa (yleensä 8-numeroinen),
  • ‘{id}’ on kohteen juokseva numero tälle käyttäjälle (numerointi alkaa ‘1’:lla jokaiselle käyttäjälle).

API Loppupiste

https://panel.energyfather.com/api/v1/private

Lähetä pyynnöt POST-menetelmällä.

Pyyntöjen hyväksyminen

Yksityiselle API:lle osoitettujen pyyntöjen vahvistamiseksi (valtuuttamiseksi) on välitettävä HTTP-otsake:

Token: {token}

Valtuutusmerkkien hallinta sijaitsee ohjauspaneelissa sivulla "Ostaja > API merkit".

Voit esimerkiksi saada tietoja tilauksesta 123456 seuraavalla tavalla:

CURL -X POST 'https://panel.energyfather.com/api/v1/private/order/get/123456' 
-H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

Tilauksen tila

  • "0" - Vireillä. Tilaus on juuri luotu.
  • "1" - Odotamme maksua. Maksulinkki on jo luotu, EnergyFather odottaa takaisinsoittoa maksujärjestelmästä. Tätä tilaa ei käytetä, jos tilaus maksetaan kokonaan sisäisellä tilillä olevilla varoilla.
  • "2" - Energian delegointimenettely on käynnissä.
  • "3" - Delegoitu. Energiaa jaetaan.
  • "4" - Reclaimed (Undelegated). Energia vedetään pois maksetun ajanjakson päättymisen vuoksi.
  • "5" - Maksettu. Tilaus on maksettu ja lisätty energian toimitusjonoon.
  • "6" - Virhe.

Tavallinen tilojen järjestys: 0, 5, 2, 3, 4.

API menetelmät
  • /api/v1/private/buy/energy - osta energiaa (maksetaan sisäiseltä tililtä)
  • /api/v1/private/order/list - saat luettelon tilauksistasi
  • /api/v1/private/order/get/{guid} - saada tietoa tilauksestasi
  • /api/v1/private/account/list - hanki luettelo sisäisistä tileistäsi.
  • /api/v1/private/account/get/{id} - saat tietoja sisäisestä tilistäsi.

"buy/energy" menetelmä - osta energiaa (maksetaan sisäiseltä tililtä).

Rekisteröityneen asiakkaan pyyntö ostaa energiaa veloittamalla sisäiseltä tililtä. Energia lähetetään välittömästi ilmoitettuun osoitteeseen.

Jos sisäisellä tilillä ei ole riittävästi varoja, tilaus luodaan ja se saa heti tilan "6" (Virhe). Tässä tapauksessa sinun täytyy käydä paneelissa, tallettaa varoja ja lähettää sitten uusi API pyyntö energian ostoa varten.

Ostettavan energian määrä voidaan määritellä kahdella tavalla:

a) Voit asettaa tarkan energiamäärän "amount"-parametrissa, jolloin sinun on asetettava myös amount_source="amount".

b) Jos et tiedä, kuinka paljon energiaa tarvitaan transaktion lähettämiseen USDT tai toisen tokenin lähettämiseen, voit asettaa amount_source="estimate" ja täyttää asianmukaiset parametrit (estimate_to, estimate_token, estimate_adjust_percent).

buy/energy: Esimerkkipyyntö tarkalla energiamäärällä

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/buy/energy' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS' 
  -d '{
    "format": "json",
    "to":     "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
    "amount_source": "amount", 
    "amount": 31895,
    "period_type": "days",
    "period_amount": 3
}'

buy/energy: Esimerkkipyyntö ja tarvittavan energiamäärän laskeminen

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/buy/energy' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS' 
  -d '{
    "format": "json",
    "to":     "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
    "amount_source": "estimate", 
    "estimate_to": "TLVkYEp4Ue2RpK5v1XNZAB3769g44BSZyH,TJm6HiCMVZdBHbNHThdMv1RambstJPrfYo",
    "estimate_token": "USDT",
    "estimate_adjust_percent": 0.04,
    "period_type": "days",
    "period_amount": 3
}'

buy/energy: Pyyntöparametrit

  • to (merkkijono, pakollinen) - TRON osoite, johon energia siirretään.
  • period_amount (kokonaisluku, pakollinen) - ajanjakso, jona energiaa ostetaan.
  • period_type (string, pakollinen) - aikajakson tyyppi. Mahdollisia arvoja: days, hours.
  • format (merkkijono, valinnainen) - vastausmuoto. Mahdolliset arvot: json (default), xml.
  • amount_source (merkkijono, vaaditaan) - algoritmi delegoidun energian määrän määrittämiseksi. Jos arvo on "amount", käytetään parametrin "amount" arvoa. Jos arvo on "estimate", tarvittava energiamäärä lasketaan parametrien estimate_to, estimate_token, estimate_adjust_percent perusteella. Mahdollisia arvoja: amount, estimate.
  • amount (kokonaisluku, vaaditaan, jos amount_source="amount") - ostettavan energian määrä. Sitä ei oteta huomioon, jos amount_source="estimate".
  • estimate_to (merkkijono, pakollinen, jos amount_source="estimate") - pilkulla erotettu luettelo TRON osoitteista, joihin merkkitapahtumat on tarkoitus lähettää.
  • estimate_token (merkkijono, vaaditaan, jos amount_source="estimate") - TRC20-tunniste. Mahdolliset arvot (isot ja pienet kirjaimet huomioiden): USDT, USDC, USDD, USDJ, JST, TUSD, stUSDT, WTRX.
  • estimate_adjust_percent (desimaaliluku, vaaditaan, jos amount_source="estimate") - ylimääräisen energian määrä prosentteina ilmaistuna. Tämä ylimäärä tarvitaan, jotta vältetään palaminen TRX, joka voi tapahtua, jos osoitteessa on täsmälleen tarvittava määrä energiaa. Suositeltava arvo on 0.04%.

Tärkeää: Tällä hetkellä vain 6 ajanjaksoa on voimassa: 1 hour ja 1, 3, 7, 15, 30 days.

buy/energy: Vastaus

Onnistuessaan vastaus sisältää tilauksen GUID, jonka avulla voit myöhemmin saada sen todelliset tiedot.

{
	"status": "ok",
	"data": {
		"guid": 81373165,
		"estimate_task_id": null,
		"status": 0,
		"order_cost": "6.051",
		"to": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
		"energy_amount": 61000,
		"period_type": "hours",
		"energy_delegation_fee": "0.561000000000000000",
		"address_activation_fee": "0.000000000000000000",
		"hours": 1,
		"days": 0,
		"estimate_task": null
	},
	"balance": "7.29412"
}

Jos pyyntö sisältää amount_source="estimate", vastauksessa on lisäosa "estimate_task". Esim:

{
	"status": "ok",
	"data": {
		"guid": 77082757,
		"estimate_task_id": 42708906,
		"status": 0,
		"order_cost": "0.561",
		"to": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
		"energy_amount": null,
		"period_type": "hours",
		"energy_delegation_fee": "0.561000000000000000",
		"address_activation_fee": "0.000000000000000000",
		"hours": 1,
		"days": 0,
		"estimate_task": {
			"id": 42708906,
			"token": "USDT",
			"currency": "USD",
			"from": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
			"to": [
				"TLVkYEp4Ue2RpK5v1XNZAB3769g44BSZyH",
				"TJm6HiCMVZdBHbNHThdMv1RambstJPrfYo"
			]
		}
	},
	"balance": "18.29412"
}

buy/energy: Vastausparametrit

  • guid - tilaus GUID
  • balance - sisäisellä tilillä tällä hetkellä käytettävissä olevat varat, TRX.
  • days - energiantoimituksen kesto päivinä, jos "period_type=days"
  • hours - energian toimituksen kesto tunteina, jos "period_type=hours".
  • estimate_task - laskelma (arvio) energiasta, joka tarvitaan TRC20-tapahtumien lähettämiseen yhdestä TRON-osoitteesta toisen TRON-osoitteen luetteloon.

"order/get/{guid}" Menetelmä - tilauksen yksityiskohtien selvittäminen

Tietojen saaminen tietystä tilauksesta.

order/get/{guid} - Esimerkkipyyntö

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/order/get/12345' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

order/get/{guid} - Esimerkkivastaus

{
	"status": "ok",
	"data": {
		"guid": 81373165,
		"estimate_task_id": 32301594,
		"status": 3,
		"payment_status": 0,
		"order_cost_paid": "4.146350000000000000",
		"order_cost": "4.146350000000000000",
		"to": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
		"energy_amount": 31895,
		"period_type": "hours",
		"energy_delegation_fee": "0.000000000000000000",
		"address_activation_fee": "0.000000000000000000",
		"hours": 1,
		"days": 0,
		"resource_txs": [
			{
				"order_guid": 81373165,
				"delegate_txid": "961b6fbd7cc2090d1a65abc06bfabde1046e02d35394f6eca8d05812a6e3ab7"
			}
		],
		"estimate_task": {
			"id": 42708906,
			"token": "USDT",
			"currency": "USD",
			"from": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
			"to": [
				"TLVkYEp4Ue2RpK5v1XNZAB3769g44BSZyH",
				"TJm6HiCMVZdBHbNHThdMv1RambstJPrfYo"
			]
		}
	}
}

order/get/{guid} - Vastausparametrit

  • guid - tilaus GUID
  • balance - sisäisellä tilillä tällä hetkellä käytettävissä olevat varat, TRX.
  • days - energiantoimituksen kesto päivinä, jos "period_type=days"
  • hours - energian toimituksen kesto tunteina, jos "period_type=hours".
  • to - TRX osoite, johon energia toimitetaan.
  • energy_amount - energiamäärä
  • order_cost - tilauskustannukset, TRX
  • order_cost_paid - jo maksettu summa, TRX (jos sisäisellä tilillä ei ole riittävästi varoja, tämä summa on pienempi kuin "order_cost").
  • address_activation_fee - kohdeosoitteen aktivointimaksun suuruus, TRX.
  • energy_delegation_fee - maksu liian pienestä tilauskoosta, TRX
  • resource_txs - array, joka sisältää luettelon transaktioista TRON lohkoketjussa, joissa resursseja on delegoitu ja palautettu (jaelegoituja)
  • status - tilauksen tila, mahdolliset arvot on kuvattu tämän käsikirjan alussa.
  • payment_status - tilauksen maksun tila maksujärjestelmässä (mahdolliset arvot riippuvat maksujärjestelmästä).

"order/list" menetelmä - tilausten luettelon saaminen

Tilausten luettelon saaminen.

order/list - Esimerkkipyyntö

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/order/list' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

order/list - Pyyntöparametrit

  • sort (merkkijono, valinnainen) - merkintöjen lajittelu, oletusarvoisesti "created_at|desc"
  • per_page (kokonaisluku, valinnainen) - rajoittaa merkintöjen lukumäärää vastausta kohden.
  • page (kokonaisluku, valinnainen) - vastaussivun juokseva numero.
  • filter (joukko arrays(objects), valinnainen) - merkintöjen suodatin.

order/list - Esimerkkivastaus

{
	"current_page": 1,
	"data": [
		{
			"guid": 96134274,
			"status": 4
		},
		{
			"guid": 81373165,
			"status": 3
		}
	],
	"first_page_url": "/api/v1/private/order/list?page=1",
	"from": 1,
	"last_page": 1,
	"last_page_url": "/api/v1/private/order/list?page=1",
	"links": [
		{
			"url": null,
			"label": "pagination.previous",
			"active": false
		},
		{
			"url": "/api/v1/private/order/list?page=1",
			"label": "1",
			"active": true
		},
		{
			"url": null,
			"label": "pagination.next",
			"active": false
		}
	],
	"next_page_url": null,
	"path": "/api/v1/private/order/list",
	"per_page": 15,
	"prev_page_url": null,
	"to": 2,
	"total": 2,
	"draw": null,
	"status": "ok"
}

order/list - Vastausparametrit

  • guid - tilauksen GUID-tunnus
  • status - vastauksen API tila

"account/list" Menetelmä - sisäisten tilien luettelointi

Luettelon saaminen sisäisistä tileistä ja tällä hetkellä käytettävissä olevien varojen määrästä. Koska jokaiselle sivuston osiolle on oma sisäinen tili (buyer, affiliate, seller, dealer), tilillä on useita tilejä.

account/list - Esimerkkipyyntö

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/account/list' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

account/list - Esimerkkivastaus

{
	"current_page": 1,
	"data": [
		{
			"guid": 29778748,
			"user_id": 81841325,
			"id": 1,
			"section": "affiliate",
			"currency": "TRX",
			"balance": "2.511531"
		},
		{
			"guid": 64463815,
			"user_id": 81841325,
			"id": 2,
			"section": "buyer",
			"currency": "TRX",
			"balance": "41.704"
		}
	],
	"first_page_url": "/api/v1/private/account/list?page=1",
	"from": 1,
	"last_page": 1,
	"last_page_url": "/api/v1/private/account/list?page=1",
	"links": [
		{
			"url": null,
			"label": "pagination.previous",
			"active": false
		},
		{
			"url": "/api/v1/private/account/list?page=1",
			"label": "1",
			"active": true
		},
		{
			"url": null,
			"label": "pagination.next",
			"active": false
		}
	],
	"next_page_url": null,
	"path": "/api/v1/private/account/list",
	"per_page": 15,
	"prev_page_url": null,
	"to": 2,
	"total": 2,
	"draw": null,
	"status": "ok"
}

account/list - Vastausparametrit

  • guid - GUID sisäinen tili
  • id - sisäisen tilin peräkkäinen ID.
  • section - mihin EnergyFather pääluokkaan tämä saldo kuuluu.
  • balance - käytettävissä olevat varat
  • currency - valuutta
  • user_id - Käyttäjän GUID nimi

Menetelmä "account/get/{id}" - tarkan sisäisen tilin saaminen

Sisäisen tilin saldon saaminen tiettyä EnergyFather-osaa varten. Koska jokaisella osastolla on oma tili (buyer, affiliate, seller, dealer), jokaiselle käyttäjälle on useita tilejä. Voit ensin käyttää "account/list"-menetelmää saadaksesi niiden luettelon, selvittää kiinnostavan tilin ‘id’:n ja sitten käyttää tätä ‘id’:ta saadaksesi tietyn tilin saldon.

account/get/{id} - Esimerkkipyyntö

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/account/get/1' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

account/get/{id} - Esimerkkivastaus

{
	"status": "ok",
	"data": {
		"guid": 64463815,
		"user_id": 81841325,
		"id": 2,
		"section": "buyer",
		"currency": "TRX",
		"balance": "41.704"
	}
}

account/get/{id} - Vastausparametrit

  • guid - GUID sisäinen tili
  • id - sisäisen tilin juokseva tunnus
  • section - mihin EnergyFather pääluokkaan tämä saldo kuuluu.
  • balance - käytettävissä olevat varat
  • currency - valuutta
  • user_id - Käyttäjän GUID nimi