API dokumentatsioon

EnergyFather teenus aitab osta (rentida) energiat ja ribalaiust, mida on vaja tehingute saatmiseks USDT ja teistes TRC20 krüptotokenites; ribalaiust on vaja ka igasuguste tehingute saatmiseks TRON plokiahelas, näiteks TRX saatmiseks, preemiate taotlemiseks ja Super Representatives hääletamiseks.

Energia ostmise menetlus

Energia ostmiseks tuleb registreeruda EnergyFather teenuses, võtta autoriseerimismärgis lehelt "Ostja > API märgid" ja täiendada Ostja konto saldot.

Pärast tellimuse loomist (meetod ‘buy/energy’) võib energia tarnimine toimuda mitme sekundilise või isegi minutilise viivitusega, nii et automatiseeritud süsteemide arendamisel on soovitatav perioodiliselt kontrollida tellimuse täitmist, taotledes meetodit ‘order/get/{guid}’.

Näiteks kui te kavatsete saata USDT ja soovite tehinguid odavamalt teha, ostes energiat, siis teete järgmist:

  • taotleda ‘buy/energy’ meetodit, et hinnata vajalikku energiakogust ja osta seda,
  • perioodiliselt taotleda ‘order/get/{guid}’ meetodit, kuni energia on delegeeritud (tavaliselt võtab see aega paar sekundit),
  • saata USDT (ostetud energiat kasutatakse tehingutasu maksmiseks).

Üldised märkused

Selles dokumentatsioonis tähendab väljendus, mis on mähitud kõverate sulgude sisse, nagu ‘{guid}’ või ‘{id}’, vastava muutuja väärtust:

  • ‘{guid}’ on objekti globaalne unikaalne identifikaator EnergyFather (tavaliselt 8-kohaline),
  • ‘{id}’ on selle kasutaja objekti järjekorranumber (numeratsioon algab iga kasutaja puhul ‘1’-ga).

API Lõpp-punkt

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

Saada päringuid kasutades POST meetodit.

Taotluste autoriseerimine

Et kinnitada (autoriseerida) päringuid privaatsele API, tuleb edastada HTTP päis:

Token: {token}

Autoriseerimismärkide haldamine asub juhtpaneelis, lehel "Ostja > API märgid".

Näiteks saate teavet tellimuse 123456 kohta järgmisel viisil:

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

Tellimuse staatus

  • "0" - Ootel. Tellimus on just loodud.
  • "1" - Ootab makseid. Makselink on juba loodud, EnergyFather ootab tagasikutsumist maksesüsteemist. Seda staatust ei kasutata, kui tellimus on täielikult tasutud sisekontol olevate vahenditega.
  • "2" - Energia delegeerimise menetlus on käimas.
  • "3" - Delegeeritud. Energia antakse välja.
  • "4" - Tagasinõutud (mittedegateeritud). Energia on tagasi võetud seoses makstud ajavahemiku lõppemisega.
  • "5" - tasuline. Tellimus on tasutud ja lisatud energia tarnimise järjekorda.
  • "6" - Viga.

Tavaline staatuste jada: 0, 5, 2, 3, 4.

API meetodid
  • /api/v1/private/buy/energy - osta energiat (makstakse sisekontolt)
  • /api/v1/private/order/list - saada oma tellimuste nimekiri
  • /api/v1/private/order/get/{guid} - saada teavet oma tellimuse kohta
  • /api/v1/private/account/list - saada nimekiri oma sisekontodest
  • /api/v1/private/account/get/{id} - saada teavet oma sisekonto kohta

"buy/energy" meetod - osta energiat (makstakse sisekontolt)

Registreeritud kliendi taotlus osta energiat sisekonto debiteerimisega. Energia saadetakse kohe määratud aadressile.

Kui sisekontol ei ole piisavalt vahendeid, luuakse tellimus ja see saab kohe staatuse "6" (Error). Sellisel juhul peate külastama paneeli, deponeerima raha ja seejärel saatma uue API taotluse energia ostmiseks.

Ostetava energiakoguse määratlemiseks on kaks võimalust:

a) Sa võid määrata täpse energiakoguse parameetris "amount", siis tuleb määrata ka amount_source="amount".

b) Kui te ei tea, kui palju energiat on vaja tehingu saatmiseks USDT või mõne muu sümboli saatmiseks, võite määrata amount_source="estimate" ja täita vastavad parameetrid (estimate_to, estimate_token, estimate_adjust_percent).

buy/energy: Näitepäring täpse energiakogusega

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: Näitepäring koos vajaliku energiakoguse arvutamisega

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: Taotluse parameetrid

  • to (string, nõutav) - TRON aadress, millele energia delegeeritakse.
  • period_amount (täisarv, nõutav) - ajavahemik, mille jooksul ostetakse energiat
  • period_type (string, nõutav) - ajavahemiku tüüp. Võimalikud väärtused: days, hours.
  • format (string, vabatahtlik) - vastuse vorming. Võimalikud väärtused: json (default), xml.
  • amount_source (string, nõutav) - delegeeritud energia koguse määramise algoritm. Kui väärtus on "amount", siis kasutatakse parameetri "amount" väärtust. Kui väärtus on "estimate", arvutatakse nõutav energiakogus parameetri estimate_to, estimate_token, estimate_adjust_percent alusel. Võimalikud väärtused: amount, estimate.
  • amount (täisarv, nõutav, kui amount_source="amount") - ostetav energiakogus. Seda ignoreeritakse, kui amount_source="estimate".
  • estimate_to (string, nõutav, kui amount_source="estimate") - komadega eraldatud loetelu TRON aadressidest, kuhu kavatsetakse saata sümboolseid tehinguid.
  • estimate_token (string, nõutav, kui amount_source="estimate") - TRC20 märgis. Võimalikud väärtused (sõltuvalt suur- ja väiketähendusest): USDT, USDC, USDD, USDJ, JST, TUSD, stUSDT, WTRX.
  • estimate_adjust_percent (kümnendkoht, nõutav, kui amount_source="estimate") - ülemäärane energiasumma väljendatuna protsentides. See ülejääk on vajalik selleks, et vältida põletamist TRX, mis võib juhtuda, kui aadressil on täpselt vajalik energiakogus. Soovitatav väärtus on 0.04%.

Oluline: Praegu kehtivad ainult 6 perioodi: 1 hour ja 1, 3, 7, 15, 30 days.

buy/energy: Vastus

Edukuse korral sisaldab vastus tellimust GUID, mille abil saate hiljem selle tegelikke andmeid.

{
	"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"
}

Kui taotlus sisaldab amount_source="estimate", siis on vastuses täiendav osa "estimate_task". Näiteks:

{
	"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: Vastusparameetrid

  • guid - tellimus GUID
  • balance - hetkel sisekontol olevad vahendid, TRX.
  • days - energiavarustuse kestus päevades, kui "period_type=days"
  • hours - energiavarustuse kestus tundides, kui "period_type=hours"
  • estimate_task - arvutus (hinnang) energia, mis on vajalik TRC20 tehingute saatmiseks ühelt TRON aadressilt teise TRON aadresside loetellu.

"order/get/{guid}" meetod - tellimuse üksikasjade saamine

Teabe saamine konkreetse tellimuse kohta.

order/get/{guid} - Näide taotluse kohta

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

order/get/{guid} - näidisvastus

{
	"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} - Vastusparameetrid

  • guid - tellimus GUID
  • balance - hetkel sisekontol olevad vahendid, TRX.
  • days - energiavarustuse kestus päevades, kui "period_type=days"
  • hours - energiavarustuse kestus tundides, kui "period_type=hours"
  • to - TRX aadress, kuhu energiat tarnitakse
  • energy_amount - energiakogus
  • order_cost - tellimuse maksumus, TRX
  • order_cost_paid - juba makstud summa, TRX (kui sisekontol ei ole piisavalt vahendeid, on see summa väiksem kui "order_cost")
  • address_activation_fee - sihtkoha aadressi aktiveerimise tasu suurus, TRX
  • energy_delegation_fee - tasu liiga väikese tellimuse eest, TRX
  • resource_txs - massiivi, mis sisaldab tehingute nimekirja TRON plokiahelas, kus ressursid on delegeeritud ja tagasi nõutud (delegeerimata).
  • status - tellimuse staatus, võimalikud väärtused on kirjeldatud käesoleva juhendi alguses.
  • payment_status - tellimuse makse staatus maksesüsteemis (võimalikud väärtused sõltuvad maksesüsteemist)

"order/list" meetod - tellimuste nimekirja saamine

Tellimuste nimekirja saamine.

order/list - Näide taotluse kohta

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

order/list - Taotluse parameetrid

  • sort (string, valikuline) - kirjete sorteerimine, vaikimisi "created_at|desc"
  • per_page (täisarv, vabatahtlik) - piirata kirjete arvu vastuse kohta
  • page (täisarv, vabatahtlik) - vastuslehe järjekorranumber
  • filter (massiivi arrays(objects), valikuline) - kirjete filter

order/list - näidisvastus

{
	"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 - Vastusparameetrid

  • guid - tellimuse GUID
  • status - staatus API vastus

"account/list" meetod - sisekontode loetlemine

Sisekontode nimekirja saamine, sealhulgas hetkel olemasolevate vahendite summa. Kuna iga saidi osa jaoks on eraldi sisekonto (buyer, affiliate, seller, dealer), on kontol mitu kontot.

account/list - Näide taotluse kohta

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

account/list - näidisvastus

{
	"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 - Vastusparameetrid

  • guid - GUID sisemine konto
  • id - järjestikune ID sisemine konto
  • section - millisesse EnergyFather jaotisse see saldo kuulub
  • balance - olemasolevad vahendid
  • currency - valuuta
  • user_id - GUID kasutaja user_id GUID.

"account/get/{id}" meetod - täpse sisekonto saamine

Sisekonto saldo saamine konkreetse EnergyFather jaotise kohta. Kuna igal sektsioonil on oma konto (buyer, affiliate, seller, dealer), on iga kasutaja jaoks mitu kontot. Nende nimekirja saamiseks saab kõigepealt kasutada "account/list" meetodit, leida huvipakkuva konto ‘id’ ja seejärel kasutada seda ‘id’ konkreetse konto saldo saamiseks.

account/get/{id} - Näide taotluse kohta

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

account/get/{id} - näidisvastus

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

account/get/{id} - Vastusparameetrid

  • guid - GUID sisemine konto
  • id - sisekonto järjestikune ID
  • section - millisesse EnergyFather jaotisse see saldo kuulub
  • balance - olemasolevad vahendid
  • currency - valuuta
  • user_id - GUID kasutaja user_id GUID.